# Alibaba Cloud Hologres API

> Alibaba Cloud Hologres API on Apizie: 93 endpoints (Binds a follower instance to a leader instance, Updates the resource group of a Hologres instance, Creates a database, Creates an external database, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-hologram/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-hologram`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/hologram
- Page: https://zieapi.vercel.app/api/cloud/aliyun-hologram
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-hologram/openapi.json

Alibaba Cloud OpenAPI for Hologres (hologram, version 2022-06-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Binds a follower instance to a leader instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/bind-leader-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region |
| instanceId | string | yes | The ID of the follower instance |
| leaderInstanceId | string | no | The ID of the leader instance. The follower and leader instances must be in the same region and zone, and have the same version. Obtain… |

### Updates the resource group of a Hologres instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | no | Instance ID |
| newResourceGroupId | string | no | New resource group ID |

### Creates a database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/create-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the Hologres instance |
| databaseName | string | no | The name of the database |
| permissionModel | string | no | The permission model. For more information, see Hologres permission models… |

### Creates an external database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/create-external-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| comment | string | no | The comment |
| databaseName | string | no | The database name |
| defaultUserMapping | string | no | Specifies whether to use the default user mapping |
| externalConfig | array | no | The configuration parameters. For more information, see CREATE EXTERNAL DATABASE… |
| metastoreType | string | no | The metastore type |

### Creates a virtual warehouse
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/create-holo-warehouse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID. This parameter is required |
| clusterCount | integer | no | The number of clusters |
| cpu | string | yes | The specifications of the virtual warehouse. The value must be a multiple of 16. The minimum value is 16 |
| name | string | yes | The virtual warehouse name |

### Creates a Hologres instance in the specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| autoPay | string | no | Specifies whether to enable automatic payment. Valid values: true (default): Automatic payment is enabled. false: An order is generated,… |
| autoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: Auto-renewal is enabled. false (default): Auto-renewal is disabled |
| chargeType | string | yes | The billing method. Valid values: PrePaid: Subscription. PostPaid: Pay-as-you-go. This parameter is ignored for shared instances. Shared… |
| coldStorageSize | integer | no | The cold storage capacity of the instance. Unit: GB. This parameter is ignored for pay-as-you-go (PostPaid) instances |
| cpu | integer | no | The instance type. Valid values: 32 vCPUs and 128 GB of memory (2 compute nodes) 64 vCPUs and 256 GB of memory (4 compute nodes) 96 vCPUs… |
| duration | integer | no | The subscription duration, such as two months. Specify this parameter only for subscription instances |
| enableServerlessComputing | string | no | Specifies whether to enable Serverless Computing |
| gatewayCount | integer | no | The number of gateways. Valid values: [2, 50]. You must specify this parameter only for virtual warehouse instances |
| initialDatabases | string | no | The initial database |
| instanceName | string | yes | The instance name. The name must be 2 to 64 characters in length. A letter is counted as one character |
| instanceType | string | yes | The instance type. Valid values: Standard: General-purpose instance. Follower: Read-only secondary instance. Warehouse: Virtual warehouse… |
| leaderInstanceId | string | no | The ID of the primary instance. This parameter is required for secondary instances. The primary and secondary instances must meet the… |
| pricingCycle | string | no | The billing cycle. Valid values: Month: The instance is billed on a monthly basis. Hour: The instance is billed on an hourly basis.… |
| regionId | string | yes | The region ID. For more information, see Endpoints… |
| resourceGroupId | string | no | The resource group. If you leave this parameter empty, the default resource group for your account is used |
| storageSize | integer | no | The standard storage capacity of the instance. Unit: GB. This parameter is ignored for pay-as-you-go (PostPaid) instances |
| storageType | string | no | The storage class |
| vSwitchId | string | yes | The ID of the vSwitch. The vSwitch must be in the same zone as the instance |
| vpcId | string | yes | The ID of the virtual private cloud (VPC). The VPC must be in the same region as the instance |
| zoneId | string | yes | The zone ID |

### Creates a manual backup for an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/create-manual-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | no | The instance ID |

### Creates a model service that allows AI functions to invoke models. You can create a service for two types of…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/create-model-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| apiKey | string | no | The API key for Alibaba Cloud Model Studio. This parameter is required only for Model Studio models. You can obtain this key from the… |
| cpu | integer | no | The number of vCPUs. This parameter is required only for a Hologres AI node |
| gpu | integer | no | The number of GPUs. This parameter is required only for a Hologres AI node |
| gpuMemory | integer | no | The GPU memory size in GB. This parameter is required only for a Hologres AI node |
| memory | integer | no | The memory size in GB. This parameter is required only for a Hologres AI node |
| modelParams | string | no | The model parameters, required only for Model Studio models. You can provide the default parameters returned by the `ListModelCatalog`… |
| modelServiceName | string | yes | A custom name for the model service |
| modelType | string | yes | The name of the model. To find the name, call `ListModelCatalog` for a model from Alibaba Cloud Model Studio, or… |
| provider | string | no | The provider of the underlying model |
| serviceCount | integer | no | The number of replicas. This parameter is required only for a Hologres AI node |
| taskType | string | no | The type of task the model performs, such as `chat/completions` or `embedding`. To find the supported task types, see the output of the… |

### Adds a RAM user or an STS account to a Hologres instance. Once added, the account can be used to log on to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| superUser | string | no | Specifies whether the user is a superuser |
| userName | string | no | The user name. Only RAM users and STS accounts are supported. The user name must be prefixed with "p4_" for RAM users (e.g., p4\234253434)… |

### Creates a warehouse
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/create-warehouse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |
| config | string | no | The configuration settings |
| cpu | string | no | The number of CPU cores |
| warehouseName | string | no | The warehouse name |

### Creates a time-based elastic scaling plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/create-warehouse-schedule-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The Hologres instance ID |
| description | string | no | The description of the time-based elastic scaling plan |
| elasticCu | integer | yes | The number of elastic CPU cores. The value must be a multiple of 16, and must be greater than or equal to 16 and less than or equal to the… |
| endTime | string | yes | The end time. The value is in the HHmm format (four digits, 24-hour clock) and must be on the hour or half hour, such as 0030, 0100, or… |
| startTime | string | yes | The start time. The value is in the HHmm format (four digits, 24-hour clock) and must be on the hour or half hour, such as 0030, 0100, or… |
| warehouseId | integer | yes | The compute group ID. You can call ListWarehouses to obtain this ID |

### Deletes a backup
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/delete-backup-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region |
| id | string | yes | The ID of the backup |

### Deletes a virtual warehouse
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/delete-holo-warehouse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| name | string | yes | The name of the virtual warehouse |

### Releases an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |

### Deletes a model resource. This action permanently deletes all models deployed on the node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/delete-model-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| aiInstanceId | string | no | The AI node instance ID |

### Deletes a specified model service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/delete-model-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| modelServiceName | string | no | The name of the model service |

### Deletes a warehouse schedule task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/delete-warehouse-schedule-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| id | string | yes | The ID of the time-sharing elastic scaling plan |
| warehouseId | string | no | The ID of the warehouse |

### Lists all tags
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/describe-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| tagsOnly | string | no | Specifies whether to return tags |

### Shuts down the ExecuteStatement API access permissions for a specified Hologres instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/disable-execute-statement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The Hologres instance ID |

### Disables data lake acceleration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/disable-hive-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |

### Disables the instance log
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/disable-operation-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| id | string | yes | The event ID |

### Disables SSL encryption for a Hologres instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/disable-ssl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance. This parameter is required |

### Disables a Support Account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/disable-support-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |

### Disables autoscale for a specified compute group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/disable-warehouse-auto-scale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| name | string | no | The compute group name |

### Cancels an upgrade. You can call this operation only if the upgrade task has not started or is in the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/discard-upgrade` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |

### Deletes a RAM user or an STS account from a Hologres instance. Once deleted, the user can no longer log in…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/drop-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the Hologres instance |
| superUser | string | no | Specifies whether the user is a superuser |
| userName | string | no | The user name. Only RAM users and STS accounts are supported. Prefix the name with "p4_" for a RAM user (for example, p4\234253434) or… |

### Enables SQL execution via OpenAPI for a specified Hologres instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/enable-execute-statement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the Hologres instance |

### Enables data lake acceleration for a Hologres instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/enable-hive-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |

### Enables SSL encryption for a Hologres instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/enable-ssl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID. This parameter is required |

### Enables the service account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/enable-support-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |
| enabled | string | no | A deprecated parameter |
| expireTime | string | no | The expiration time. Format: YYYY-MM-DD HH:mm:ss |
| password | string | no | The password |

### Enables auto scaling for a warehouse
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/enable-warehouse-auto-scale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| maxClusterCount | string | no | The maximum number of clusters. The value must be greater than the number of reserved clusters and less than or equal to 4 |
| name | string | no | The name of the warehouse |

### Executes an SQL statement synchronously on a specified database via OpenAPI and returns the result
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/execute-statement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| dbName | string | no | The name of the database |
| maxBytes | integer | no | The maximum size of the response, in bytes. Default: 10,485,760 (10 MB). If the response size exceeds this limit, it is truncated, as… |
| maxRows | integer | no | The maximum number of rows to return. Default: 200. Maximum: 1,000. If the result set exceeds this limit, it is truncated, as indicated by… |
| parameters | array | no | An array of bound parameters for a parameterized query. These parameters map sequentially to placeholders (e.g., `$1`, `$2`) in the SQL… |
| queryTimeout | integer | no | The query timeout, in seconds. Default: 30. Maximum: 30. Minimum: 1. If a query exceeds this time limit, the server cancels it |
| sql | string | no | The SQL statement to execute. The maximum length is 16,384 characters. You can specify multiple SQL statements separated by semicolons. If… |

### Retrieves the SSL certificate attributes of a Hologres instance, including SSL status and certificate…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/get-certificate-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance. This parameter is required |

### Checks whether a specified Hologres instance allows SQL execution through OpenAPI
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/get-execute-statement-enabled` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |

### Gets the external account login setting for HoloWeb
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/get-holo-web-login-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |

### Retrieves the details of an instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/get-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID. This parameter is required |

### Queries the list of large model services bound to a Hologres instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/get-instance-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |

### Retrieves the last upgrade history
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/get-last-upgrade-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |

### Retrieves the root SSL certificate of a Hologres instance for client-side SSL connections
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/get-root-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID. This parameter is required |

### Retrieves the backup configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/get-scheduled-backup-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | no | The instance ID |
| scheduleType | string | no | The backup type. By default, the operation returns periodical and manual backup configurations. To retrieve the remote backup… |

### Queries the upgrade status
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/get-upgrade-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |

### Queries whether an instance can be upgraded
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/get-upgradeable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |

### Retrieves the details of a virtual warehouse
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/get-warehouse-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID. This parameter is required |

### Grants permissions on a database to a specified user within a Hologres instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/grant-database-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| databaseName | string | no | The database name |
| privileges | array | no | The list of permissions |
| userName | string | no | The user ID. For more information, see https://help.aliyun.com/document_detail/130393.html |

### Grants permissions on a schema to a specified user within a Hologres instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/grant-schema-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| databaseName | string | no | The database name |
| privileges | array | no | The list of permissions |
| schemaName | string | no | The schema name |
| userName | string | no | The user ID. For more information, see https://help.aliyun.com/document_detail/130393.html |

### Grants table permissions to a specified user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/grant-table-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| allTable | string | no | Specifies whether to grant permissions on all existing tables |
| columnNames | array | no | The list of column names to grant permissions on |
| databaseName | string | no | The database name |
| privileges | array | no | The list of permissions |
| schemaName | string | no | The schema name |
| tableName | string | no | The table name |
| userName | string | no | The user ID. For more information, see https://help.aliyun.com/document_detail/130393.html |

### Retrieves a list of snapshots. Each snapshot represents a point-in-time backup that can be used to restore a…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-backup-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | no | The instance ID |
| backupType | string | no | The backup type, used to filter snapshots. If you leave this parameter empty, all snapshots are returned |

### Queries the databases in a Hologres instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-databases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| external | string | no | Specifies whether to list only foreign tables. If you set this parameter to \`true\`, only foreign tables are listed. If you set this… |

### Retrieves the read-only secondary instances of a specified Hologres primary instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-follower-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID. This parameter is located in the request path and must be provided when you call this operation |

### Queries the list of AI node resources
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-instance-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |

### Retrieves a list of instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| cmsInstanceType | string | no | The CloudMonitor instance type. Valid values: standard follower mc-acceleration warehouse high-memory serverless This is for CloudMonitor |
| resourceGroupId | string | no | The resource group ID |
| tag | array | no | The instance tags |

### Retrieves the list of possible primary instance IDs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-leader-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID. This parameter is in the request path and must be provided when you invoke this operation |

### Lists the availability zones to which an instance can be migrated. This operation applies to instances that…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-migration-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| maxResults | integer | no | The maximum number of results to return per page |
| nextToken | string | no | The token from a previous call to retrieve the next page of results. Omit this parameter to get the first page |

### Lists models
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-model-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| maxResults | integer | no | The page size. Default value: 20 Maximum value: 100 |
| nextToken | string | no | The pagination token. Set this parameter to the value of NextToken that is returned from the previous API call |
| provider | string | no | The model provider |

### Retrieves action events that match specified criteria, supporting pagination and sorting
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-operation-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| eventName | string | no | Filters events by name |
| eventNameDesc | string | no | Specifies whether to sort events by event name in descending order |
| eventType | string | no | Filters events by type |
| instanceId | string | no | The instance ID |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The page size. Default value: 50. Maximum value: 100 |
| scheduleTimeDesc | string | no | Specifies whether to sort events by schedule time in descending order |
| state | string | no | Filters events by state |

### Queries the list of all regions supported by Hologres
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |

### Retrieves the list of versions available for upgrade
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-upgrade-release-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |

### Queries the elastic scheduling events of a specified instance within a given time range
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-warehouse-schedule-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| elasticType | string | no | The elastic scaling type, including time-based elastic scaling and automatic elastic scaling. By default, all types are returned |
| endTime | integer | no | The end timestamp in seconds. Default value: the current time |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The page size. Default value: 30. Maximum value: 100 |
| startTime | integer | no | The start timestamp in seconds. Default value: three days ago |

### Retrieves the list of all time-based elastic scaling plan tasks for compute groups under a specified instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-warehouse-schedule-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |

### Retrieves a list of virtual warehouses
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hologram/list-warehouses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID. This parameter is required |

### Migrates an instance to a target availability zone. This operation only supports instances deployed across…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/migrate-instance-zone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| zoneId | string | no | The ID of the target availability zone. Call the `ListMigrationZones` operation to confirm that the target availability zone meets the… |

### Prepares an instance for an upgrade by running a pre-upgrade assessment. You can upgrade the instance only…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/prepare-upgrade` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The ID of the instance |
| dryRun | string | no | This parameter is deprecated |
| version | string | no | The target version for the upgrade. Call the ListUpgradeReleaseVersion operation to get a list of available versions |

### Rebalances shards in a virtual warehouse
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/rebalance-holo-warehouse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| name | string | yes | The name of the virtual warehouse |

### Renames a virtual warehouse
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/rename-holo-warehouse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| name | string | yes | The original name of the virtual warehouse |
| newWarehouseName | string | yes | The new name of the virtual warehouse |

### Renews a subscription Hologres instance. You can also enable monthly auto-renewal
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/renew-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| autoRenew | string | no | Specifies whether to enable monthly auto-renewal. Valid values: true: Enabled. false (default): Disabled. Enabling auto-renewal on an… |
| duration | integer | yes | The renewal period, in months |

### Renews the SSL certificate of a Hologres instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/renew-sslcertificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID. This parameter is required |

### Restarts a virtual warehouse
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/restart-holo-warehouse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| name | string | yes | The name of the virtual warehouse |

### Restarts a Hologres instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/restart-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |

### Resumes a virtual warehouse from Stopped to Running
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/resume-holo-warehouse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| name | string | yes | The name of the virtual warehouse |

### Resumes a paused instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/resume-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |

### Revokes permissions on a database from a specified user within a Hologres instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/revoke-database-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| databaseName | string | no | The name of the database |
| privileges | array | no | The list of permissions |
| userName | string | no | The user ID. For more information, see https://help.aliyun.com/document_detail/130393.html |

### Revokes permissions on a schema from a specified user within a Hologres instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/revoke-schema-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| databaseName | string | no | The database name |
| privileges | array | no | The list of permissions |
| schemaName | string | no | The schema name |
| userName | string | no | The user ID. For more information, see https://help.aliyun.com/document_detail/130393.html |

### Revokes table authorization
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/revoke-table-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| allTable | string | no | Specifies whether the revocation takes effect on all tables. Valid values: true: Yes. false or null: No |
| columnNames | array | no | The list of column names for which to revoke permissions |
| databaseName | string | no | The database name |
| privileges | array | no | The list of permissions |
| schemaName | string | no | The schema name |
| tableName | string | no | The table name |
| userName | string | no | The user ID. For more information, see https://help.aliyun.com/document_detail/130393.html |

### Scales a virtual warehouse
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/scale-holo-warehouse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| clusterCount | integer | no | The number of clusters |
| cpu | integer | yes | The number of vCPUs for the virtual warehouse. The value must be a multiple of 16 |
| name | string | yes | The name of the virtual warehouse |
| instanceId | string | yes | The instance ID |

### Modifies the specifications and storage space of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/scale-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the Hologres instance |
| coldStorageSize | integer | no | The infrequent access storage space of the instance. Unit: GB. This parameter is ignored for pay-as-you-go instances |
| cpu | integer | no | The instance specifications. Valid values: 16 cores and 64 GB (number of compute nodes: 1) 32 cores and 128 GB (number of compute nodes:… |
| enableServerlessComputing | string | no | Specifies whether to enable serverless computing |
| gatewayCount | integer | no | The number of gateways. Valid values: 2 to 50. This parameter is required only for the Warehouse type |
| scaleType | string | yes | The type of specification change. Valid values: UPGRADE: upgrades the specifications. DOWNGRADE: downgrades the specifications. When you… |
| storageSize | integer | no | The standard storage space of the instance. Unit: GB. This parameter is ignored for pay-as-you-go instances |

### Stops a running instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/stop-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |

### Stops a virtual warehouse
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/suspend-holo-warehouse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| name | string | yes | The name of the virtual warehouse |

### Adds tags to one or more resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| category | string | no | The resource type |
| resourceIds | array | no | The instance IDs |
| tagOwnerUid | integer | no | The ID of the account that owns the tag |
| tags | array | no | A collection of tags to add |
| ResourceType | string | no | The instance type. Set the value to `instance` |

### Detaches a read-only instance from its primary instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/un-bind-leader-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The ID of the read-only instance |

### Removes tags from one or more instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| category | string | no | The resource category |
| resourceIds | array | no | An array of instance IDs |
| resourceType | string | no | The resource type |
| tagKeys | array | no | An array of tag keys. To remove tags, you only need to provide the corresponding tag keys |
| tagOwnerUid | integer | no | The account ID of the tag owner |

### Enables automatic minor version updates. After this feature is enabled, the instance is automatically…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/update-auto-upgrade` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| autoUpgrade | string | no | The upgrade type. Valid values: auto: enables automatic minor version updates. manual: manual upgrade |

### Updates the description of a backup
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/update-backup-data-desc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| desc | string | no | The backup description |
| instanceId | string | no | The instance ID |
| id | string | yes | The backup ID |

### Modifies the login settings for holoweb
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/update-holo-web-login-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |
| allowExternalAccountsLogin | string | no | Set to `true` to allow logins from external accounts, or `false` to deny these logins |

### Changes the name of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/update-instance-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| instanceName | string | no | The new name of the instance. The name must be 2 to 64 characters in length. A letter is counted as one character |

### Modifies the network type of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/update-instance-network-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| anyTunnelToSingleTunnel | string | no | Specifies whether to change the network type from AnyTunnel to SingleTunnel. This parameter is not applicable to new instances. Keep the… |
| networkTypes | string | no | The network types to enable. The order of the network types does not matter. For example, if an instance has the Internet, Intranet, and… |
| vSwitchId | string | no | The ID of the vSwitch |
| vpcId | string | no | The ID of the VPC |
| vpcOwnerId | string | no | The ID of the Alibaba Cloud account that owns the VPC |
| vpcRegionId | string | no | The region ID of the VPC |

### Updates the port of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/update-instance-port` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| port | integer | no | The port of the instance. Valid values: 1 to 65535 |

### Sets the maintenance window for an instance to schedule system maintenance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/update-maintenance-window` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | `instanceId=xxx` |
| endTime | string | no | The end time. Format: HH:mm (24-hour clock) |
| startTime | string | no | The start time. Format: HH:mm (24-hour clock) |

### Updates a model service. This operation applies only to Hologres AI
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/update-model-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| cpu | integer | no | The CPU specifications |
| gpu | integer | no | The GPU specifications |
| memory | integer | no | The memory specifications |
| modelServiceName | string | yes | A custom name for the model service |
| modelType | string | no | The model name |
| serviceCount | integer | no | The number of service replicas |

### Modifies the execution time of an O&M event
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/update-operation-event-schedule-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| id | string | yes | The event ID |
| scheduleTime | string | yes | The scheduled execution time. Format: YYYY-MM-DD HH:mm:ss. Time zone: UTC+8 |

### This operation configures a backup policy for an instance. You can set a weekly schedule to back up an…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/update-scheduled-backup-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| dataKeepQuantity | integer | no | The number of scheduled backups to retain. For example, if you set this parameter to `3`, the system retains the three most recent backups… |
| dstRegion | string | no | The destination region for the backup. This parameter applies only to remote backups and enables cross-region disaster recovery. For… |
| enabled | string | no | Specifies whether to enable scheduled backups. Set this parameter to `true` to enable scheduled backups, or `false` to disable them |
| hour | integer | no | The hour to start the backup. This start time applies to all specified days. For example, if you set `week` to `1,3,5` and `hour` to `20`,… |
| instanceId | string | no | The instance ID |
| manualDataKeepQuantity | integer | no | The number of manual backups to retain. Manual backups and automatic backups are stored separately and have independent retention policies |
| scheduleType | string | no | The backup type. This parameter is required only for remote backups |
| week | string | no | Specifies the days of the week on which to perform a backup. Separate multiple days with commas. For example, to perform backups on… |
| zoneId | string | no | The destination availability zone for the backup. This parameter applies only to remote backups |

### Updates the scheduled elastic scaling plan for a compute group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/update-warehouse-schedule-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| elasticCu | integer | no | The number of elastic CPU cores. The value must be a multiple of 16, greater than or equal to 16, and less than or equal to the current… |
| endTime | string | no | The end time. The value is in the HHmm format (four digits, 24-hour clock) and must be on the hour or half hour, such as 0030, 0100, or… |
| id | string | no | The elastic scaling plan ID |
| startTime | string | no | The start time. The value is in the HHmm format (four digits, 24-hour clock) and must be on the hour or half hour, such as 0030, 0100, or… |
| warehouseId | integer | yes | The compute group ID |

### Upgrades an instance. If the preparation is successful, the instance can start the upgrade directly
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/upgrade-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |
| upgradeTime | string | no | The upgrade time |
| type | string | no | The upgrade type |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hologram.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-hologram/bind-leader-instance" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Hologres API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-hologram/bind-leader-instance with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Hologres API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Hologres itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Hologres API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-hologram.

### What is the status of the Alibaba Cloud Hologres API?
Needs your own provider key (bring your own key)