# Alibaba Cloud AnalyticDB for MySQL API

> Alibaba Cloud AnalyticDB for MySQL API on Apizie: 145 endpoints (Applies for a public endpoint for a Data Warehouse Edition cluster, Invokes the ApplyAdviceById operation to apply optimization suggestions, Creates elastic network interfaces (ENIs), a type of virtual network interface controller (NIC), for a Data…, Applies multiple optimization suggestions in batches, …) 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-adb/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for AnalyticDB for MySQL (adb, version 2019-03-15). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Applies for a public endpoint for a Data Warehouse Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/allocate-cluster-public-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the… |
| ConnectionStringPrefix | string | no | The prefix of the public endpoint. It must start with a lowercase letter and consist of lowercase letters, digits, and hyphens (-). It can… |

### Invokes the ApplyAdviceById operation to apply optimization suggestions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/apply-advice-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the cluster ID of a Data Warehouse… |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query available regions |
| AdviceId | string | no | The suggestion ID |
| AdviceDate | integer | no | The date when the suggestion was generated. Format: yyyyMMdd (UTC) |
| ApplyType | string | no | The adoption type |
| BuildImmediately | string | no | Specifies whether to immediately start the build task |

### Creates elastic network interfaces (ENIs), a type of virtual network interface controller (NIC), for a Data…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/attach-user-eni` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the… |

### Applies multiple optimization suggestions in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/batch-apply-advice-by-id-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the cluster ID of a Data Warehouse… |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query available regions |
| AdviceIdList | string | no | The list of suggestion IDs to be applied in batches. Separate multiple suggestion IDs with commas (,) |
| AdviceDate | integer | no | The date when the suggestions were generated. Format: yyyyMMdd (UTC) |
| ApplyType | string | no | The adoption type |
| BuildImmediately | string | no | Specifies whether to immediately start the build task |

### Binds a database account to a resource group in a Data Warehouse Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/bind-dbresource-group-with-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the… |
| GroupName | string | yes | The name of the resource group |
| GroupUser | string | yes | The database account to be bound. You can bind either a standard database account or a privileged database account |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, and you must ensure… |

### Binds a resource group to a database user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/bind-dbresource-pool-with-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the… |
| PoolName | string | yes | The name of the resource group |
| PoolUser | string | yes | The database account to bind. You can bind a standard database account or a privileged database account |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must ensure… |

### Cancels an O&M event
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/cancel-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| Ids | string | no | The cluster IDs |

### Checks whether the service-linked role has been created
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/check-service-linked-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the region IDs supported by the… |
| ServiceName | string | no | The service name |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the… |
| AccountName | string | yes | The name of the database account. The name must meet the following requirements: It must start with a lowercase letter and end with a… |
| AccountPassword | string | yes | The password of the database account. The password must meet the following requirements: It must contain at least three of the following… |
| AccountDescription | string | no | The description of the account. It cannot start with `http://` or `https://`. It can be up to 256 characters in length |
| AccountType | string | no | The type of the account. Valid values: Normal: standard account. You can create up to 256 standard accounts in a cluster. Super (default):… |
| Tag | string | no | The list of tags (JSON-encoded) |

### Creates a Data Warehouse Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/create-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the region ID |
| ZoneId | string | no | The zone ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the zone ID |
| DBClusterVersion | string | yes | The version of the AnalyticDB for MySQL Data Warehouse Edition cluster. Valid value: 3.0 |
| DBClusterCategory | string | yes | The edition. Valid values: Cluster: Cluster Edition in reserved mode. Cluster Edition in reserved mode is available only in regions in the… |
| DBClusterClass | string | no | The cluster specifications. Valid values: C8 C32 This parameter is required when Mode is set to Reserver (reserved mode) |
| DBNodeGroupCount | string | no | The number of node groups. Valid values: 1 to 200. The value must be an integer. This parameter is required when Mode is set to Reserver… |
| DBNodeStorage | string | no | The storage space of a node. Unit: GB. Valid values: If the cluster specifications are C8, valid values are 100 to 1000. If the cluster… |
| DBClusterNetworkType | string | yes | The network type. Valid value: VPC |
| DBClusterDescription | string | no | The description of the cluster. It cannot start with `http://` or `https://`. It must be 2 to 256 characters in length |
| PayType | string | yes | The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription |
| Period | string | no | The subscription period of the subscription cluster. Valid values: Year: yearly subscription. Month: monthly subscription. This parameter… |
| UsedTime | string | no | The subscription duration of the subscription cluster. Valid values: If Period is set to Year, valid values are 1, 2, 3, and 5. The value… |
| VPCId | string | no | The VPC ID |
| VSwitchId | string | no | The vSwitch ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| ExecutorCount | string | no | The reserved parameter. This parameter is not applicable |
| ResourceGroupId | string | no | The resource group ID |
| Tag | string | no | The list of tags (JSON-encoded) |
| Mode | string | no | The mode. Valid values: Reserver: reserved mode. Flexible: elastic mode |
| StorageResource | string | no | The reserved parameter. This parameter is not applicable |
| StorageType | string | no | The reserved parameter. This parameter is not applicable |
| ComputeResource | string | no | The compute resources that are used for data computing. Increasing compute resources can accelerate data queries. Compute resources are… |
| RestoreType | string | no | The reserved parameter. This parameter is not applicable |
| SourceDBInstanceName | string | no | The reserved parameter. This parameter is not applicable |
| BackupSetID | string | no | The reserved parameter. This parameter is not applicable |
| RestoreTime | string | no | The reserved parameter. This parameter is not applicable |
| ElasticIOResource | string | no | The elastic I/O resource (EIU). For more information, see https://help.aliyun.com/document_detail/189505.html |
| DiskEncryption | string | no | Specifies whether to enable cloud disk encryption. Valid values: true: yes. false: no |
| KmsId | string | no | The KMS ID that is used for cloud disk encryption. This parameter takes effect only when DiskEncryption is set to true |
| EnableSSL | string | no | Specifies whether to enable SSL encryption. Valid values: true: enables SSL encryption. false: disables SSL encryption |

### Creates a resource group for a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/create-dbresource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. Call the https://help.aliyun.com/document_detail/129857.html operation to query the IDs of all Data Warehouse Edition… |
| GroupName | string | yes | The name of the resource group. The name can be up to 255 characters in length. The name must start with a digit or an uppercase letter.… |
| GroupType | string | no | The query type. Valid values: interactive (default): interactive query mode. batch: batch query mode. Job: offline job mode |
| MinComputeResource | string | no | The minimum reserved computing resources, in ACU. If the resource group type is Interactive, the minimum reserved computing resources are… |
| MaxComputeResource | string | no | The maximum reserved computing resources, in ACU. If the resource group type is Interactive, the maximum reserved computing resources are… |
| ClusterSizeResource | string | no | The resource specifications of a single cluster, in ACU |
| MinClusterCount | integer | no | The minimum number of clusters that must run in the resource group. The minimum value is 1 |
| MaxClusterCount | integer | no | The maximum number of clusters that can run in the resource group. The maximum value is 10 |
| ClusterMode | string | no | The mode of the resource group. Valid values: Disable (default): regular mode. AutoScale: auto-scaling mode |
| Engine | string | no | The engine of the resource group. Valid values: AnalyticDB (default): the AnalyticDB for MySQL engine. SparkWarehouse: the SparkWarehouse… |
| EngineParams | string | no | The configuration parameters for the Spark application. These parameters apply to all Spark jobs that are executed in the resource group.… |
| NodeNum | integer | no | The number of nodes. The default value is 0. The resources of one node are 16 cores and 64 GB. The number of nodes cannot be too large.… |
| ClientToken | string | no | A client token used to ensure the idempotence of the request. The client generates this value to make sure that it is unique among… |

### You can call the CreateDBResourcePool operation to create a resource group. This operation applies only to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/create-dbresource-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL cluster. Call the https://help.aliyun.com/document_detail/129857.html operation to query the IDs of all… |
| PoolName | string | yes | The name of the resource group. The name can be up to 255 characters in length. It must start with a digit, an uppercase letter, or a… |
| QueryType | string | no | The execution mode of the SQL query. Valid values: batch: batch processing mode. interactive (default): interactive mode. For more… |
| NodeNum | integer | no | The number of nodes. The default value is 0. A single node provides 16 cores and 64 GB of memory. The total resources, calculated as… |

### Creates a scheduled scaling plan. This operation can be used only for AnalyticDB for MySQL clusters in…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/create-elastic-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| ElasticPlanName | string | yes | The name of the scaling plan. The name must be 2 to 30 characters in length. The name can contain letters, digits, and underscores (_) |
| ResourcePoolName | string | no | The name of the resource group. You can call the https://help.aliyun.com/document_detail/466685.html operation to query the resource group… |
| ElasticPlanNodeNum | integer | no | The number of nodes that are involved in the scaling plan. If ElasticPlanType is set to worker, you can set this parameter to 0 or leave… |
| ElasticPlanTimeStart | string | yes | The scale-up time of the scaling plan. Specify the time on the hour in the HH:mm:ss format |
| ElasticPlanTimeEnd | string | yes | The restoration time of the scaling plan. Specify the time on the hour in the HH:mm:ss format. The interval between the scale-up time and… |
| ElasticPlanWeeklyRepeat | string | no | The days of the week when you want to execute the scaling plan. Valid values: 0 to 6 (Sunday to Saturday). Separate multiple values with… |
| ElasticPlanMonthlyRepeat | string | no | The dates of the month when you want to execute the scaling plan. A number specifies a date of the month. Separate multiple values with… |
| ElasticPlanStartDay | string | no | The start date of the scaling plan. Specify the date in the yyyy-MM-dd format |
| ElasticPlanEndDay | string | no | The end date of the scaling plan. Specify the date in the yyyy-MM-dd format |
| ElasticPlanEnable | string | no | Specifies whether the scaling plan takes effect. Valid values: true (default) false |
| ElasticPlanType | string | no | The type of the scaling plan. Valid values: worker: scales only elastic I/O resources. executor: scales only computing resources.… |
| ElasticPlanWorkerSpec | string | no | The resource specifications that can be scaled up by the scaling plan. Valid values: 8 Core 64 GB (default) 16 Core 64 GB 32 Core 64 GB 64… |

### Creates a service-linked role
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/create-service-linked-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| ServiceName | string | no | The service name |

### The DeleteAccount operation deletes a database account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/delete-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The instance ID |
| AccountName | string | yes | The database account name |
| AccountType | string | no | Normal: a standard account. Super: a privileged account |

### Manually deletes backup sets
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/delete-backups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL cluster |
| BackupIds | string | yes | The ID of the backup set that you want to delete. Separate multiple backup set IDs with commas (,) |
| RegionId | string | no | The region ID of the cluster |

### Deletes an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/delete-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster |

### Deletes a resource group from an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/delete-dbresource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| GroupName | string | yes | The name of the resource group |

### Deletes a resource group. You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/delete-dbresource-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| PoolName | string | yes | The name of the resource group |

### Deletes a scheduled scaling plan. You can call this operation only for AnalyticDB for MySQL Data Warehouse…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/delete-elastic-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/612241.html… |
| ElasticPlanName | string | yes | The name of the scaling plan. You can call the https://help.aliyun.com/document_detail/601334.html operation to query the names of scaling… |

### Queries abnormal SQL patterns within a time range
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-abnormal-pattern-detection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the information about all… |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent region list |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| EndTime | string | no | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| Lang | string | no | The language. Valid values: zh (default): simplified Chinese. en: English |

### Describes the database accounts of an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL cluster. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the… |
| AccountName | string | no | The name of the database account. If you omit this parameter, information about all database accounts is returned |
| Tags | string | no | The resource tags (JSON-encoded) |
| AccountType | string | no | The account type. By default, accounts of all types are returned. Valid values: Normal: a standard account. Super: a privileged account |

### Queries the configuration information about O\\&M tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-active-operation-maintain-conf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| RegionId | string | no | The region ID |
| Ids | string | no | The cluster ID |

### Retrieves O&M events
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| Region | string | no | The region information |
| TaskType | string | no | The task type. A value of all indicates that all tasks of the user are queried. Set this parameter to all |
| PageSize | integer | no | The number of entries per page. Default value: 25 |
| PageNumber | integer | no | The page number. The value must be greater than 0. Default value: 1 |
| ProductId | string | no | The product ID |
| DbType | string | no | The database type |
| Status | integer | no | The task status. Valid values: -1: all pending and running tasks 3: pending 4: running |
| InsName | string | no | The instance name |
| AllowChange | integer | no | Specifies whether the time can be modified. Valid values: -1: The time of all O&M events can be modified. 0: The time cannot be modified.… |
| AllowCancel | integer | no | Specifies whether cancellation is allowed. Valid values: -1: All O&M events can be canceled. 0: Cancellation is not allowed. 1:… |
| ChangeLevel | string | no | The change level. Default value: all. Valid values: all: all levels including exception fix and system maintenance S0: exception fix S1:… |

### Queries whether the suggestion feature is enabled for an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-advice-service-enabled` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the IDs of all AnalyticDB for… |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |

### Queries the information about an account or the list of accounts of a specific database within an AnalyticDB…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-all-accounts` (byok)

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

### Enumerates all databases, tables, and columns in a specified cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-all-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/612241.html operation to query the… |
| SchemaName | string | yes | The name of the database |
| TableName | string | yes | The name of the table |

### Call `DescribeAppliedAdvices` to retrieve applied optimization suggestions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-applied-advices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster. To query the IDs of AnalyticDB for MySQL Data Warehouse Edition… |
| RegionId | string | yes | The region ID. To query available region IDs, call the https://help.aliyun.com/document_detail/143074.html API |
| StartTime | integer | no | The start date of the query time range, in yyyyMMdd format and in UTC |
| EndTime | integer | no | The end date of the query time range, in yyyyMMdd format and in UTC |
| Lang | string | no | The language of the suggestions. Valid values: zh: Simplified Chinese (default) en: English ja: Japanese zh-tw: Traditional Chinese |
| PageSize | integer | no | The number of entries to return per page. Valid values: 30 (default) 50 100 |
| PageNumber | integer | no | The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the integer data type.… |
| AdviceType | string | no | The type of suggestions to return. Valid values: INDEX: index optimization. TIERING: data tiering |
| Keyword | string | no | A keyword for performing a fuzzy search by table name |
| SchemaTableName | string | no | The schema name and table name. The value must be in the ` . ` format |
| Order | string | no | The sort order for the results. The value must be a JSON string, such as `[{"Field":"SchemaName","Type":"Asc"}]`. The JSON string contains… |

### Queries the SQL audit settings of an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-audit-log-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |

### Queries the SQL audit logs of a Data Warehouse Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-audit-log-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/129857.html operation to view the… |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the regions and zones supported by… |
| StartTime | string | no | The start time of the query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. You can… |
| EndTime | string | no | The end time of the query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end… |
| DBName | string | no | The name of the database where the SQL statement is executed |
| QueryKeyword | string | no | The keyword used to filter SQL statements |
| SqlType | string | no | The type of the SQL statement. Valid values: DELETE SELECT UPDATE INSERT_INTO_SELECT ALTER DROP CREATE You can specify only one SQL type… |
| Succeed | string | no | Specifies whether the SQL statement was executed successfully. Valid values: true: The SQL statement was executed successfully. false: The… |
| HostAddress | string | no | The IP address and port number of the client that executed the SQL statement |
| OrderType | string | no | The sort order of the SQL statements by execution time. Valid values: asc: ascending order. desc: descending order |
| User | string | no | The username of the user who executed the SQL statement |
| Order | string | no | The sorting rules based on specified fields. The value is an ordered JSON array that specifies composite sorting based on the sequence of… |
| PageSize | integer | no | The number of entries per page. Valid values: 10 30 50 100 If this parameter is not specified, the default value is 10 |
| PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: 1 |
| ProcessId | string | no | The process ID of the SQL query. This parameter is used to filter the audit logs of a specified process |

### Queries the auto-renewal status of a subscription AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-auto-renew-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the cluster |
| DBClusterIds | string | yes | The cluster ID. Separate multiple clusters with commas (,) |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| ResourceGroupId | string | no | The ID of the resource group |

### Use `DescribeAvailableAdvices` to get optimization advice
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-available-advices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the cluster. You can call the https://help.aliyun.com/document_detail/129857.html API to query for the IDs of Data Warehouse… |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html API to query for the IDs of available regions |
| AdviceDate | integer | yes | The date on which the advice was generated, in the yyyyMMdd format and in UTC. Advice is generated daily after an early-morning analysis.… |
| Lang | string | yes | The language for the advice. Valid values: zh: simplified Chinese (default) en: English ja: Japanese zh-tw: traditional Chinese |
| PageSize | integer | yes | The number of entries per page. Valid values: 30 (default) 50 100 |
| PageNumber | integer | yes | The page number. The value must be a positive integer. Default value: 1 |
| AdviceType | string | no | The type of advice. Valid values: INDEX: index optimization. TIERING: data tiering optimization |
| Keyword | string | no | The keyword for a fuzzy search by table name |
| SchemaTableName | string | no | The concatenation of the database name and the table name |
| Order | string | no | The sort order of the query results. The value is a JSON string, for example, `[{"Field":"SchemaName","Type":"Asc"}]`. The JSON string… |

### Queries the available resources in a specified zone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-available-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/143074.html to query the region ID |
| ZoneId | string | no | The zone ID. You can call https://help.aliyun.com/document_detail/143074.html to query the zone ID |
| ChargeType | string | no | The billing method. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go |
| AcceptLanguage | string | no | The language of the response. Valid values: zh-CN (default): Chinese. en-US: English |
| DBClusterVersion | string | no | The cluster version of the Data Warehouse Edition |

### Queries the backup settings of an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-backup-policy` (byok)

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

### Queries the backup list of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-backups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the… |
| BackupId | string | no | The ID of the backup set |
| StartTime | string | no | The start time of the query. Format: yyyy-MM-ddTHH:mmZ |
| EndTime | string | no | The end time of the query. The end time must be later than the start time. Format: yyyy-MM-ddTHH:mmZ |
| PageSize | integer | no | The number of entries per page. Valid values: 30 (default) 50 100 |
| PageNumber | integer | no | The page number. Valid values: positive integers that are greater than 0 and do not exceed the maximum value of the Integer data type.… |
| CrossUid | string | no | The Alibaba Cloud account that owns the backup set in cross-account backup scenarios. Specify this parameter only for cross-account backups |
| CrossRole | string | no | The name of the RAM role under the Alibaba Cloud account that owns the backup set in cross-account backup scenarios. Specify this… |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the regions and zones supported by… |

### Queries the bad SQL statements that affect cluster stability within a time range
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-bad-sql-detection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/98094.html operation to query the information about all… |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/454314.html operation to query the most recent region list |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… |
| EndTime | string | no | The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mmZ format. The… |
| Lang | string | no | The language. Valid values: zh (default): simplified Chinese. en: English. ja: Japanese. zh-tw: traditional Chinese |

### Enumerates the columns of a specified table in an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-columns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| SchemaName | string | yes | The database name |
| TableName | string | yes | The table name |

### Queries the specifications of computing resources for AnalyticDB for MySQL Data Warehouse Edition clusters…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-compute-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |
| DBClusterVersion | string | no | The version of the AnalyticDB for MySQL Data Warehouse Edition cluster. Set the value to 3.0 |
| ZoneId | string | no | The zone ID of the cluster. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the most recent zone… |
| DBClusterId | string | no | The cluster ID |
| Migrate | string | no | Specifies whether to query the specifications of the available computing resources that are migrated from AnalyticDB for MySQL Data… |

### Returns the current number of connections to the specified AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-connection-count-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the details of all AnalyticDB for… |
| RegionId | string | no | The region ID |

### Queries the diagnostic results of the access layer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-controller-detection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/129857.html… |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent region list |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| EndTime | string | no | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.… |
| Lang | string | no | The language. Valid values: zh: simplified Chinese. en: English |

### Queries a list of IP address whitelists for an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbcluster-access-white-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| RegionId | string | no | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |

### Queries the details of a specified AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbcluster-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/129857.html… |
| RegionId | string | no | The region ID of the cluster |

### Queries the health status of an AnalyticDB for MySQL Data Warehouse Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbcluster-health-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| RegionId | string | yes | The ID of the region. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent region list |

### Call the DescribeDBClusterNetInfo API to retrieve network information about an ADB cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbcluster-net-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | Cluster ID |
| RegionId | string | no | The region ID of the cluster |
| Engine | string | no | Database engine |

### Queries the performance data of a specified cluster by calling the DescribeDBClusterPerformance operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbcluster-performance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL cluster. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the… |
| Key | string | no | The name of the performance metric (monitoring key) to query. Separate multiple values with commas (,). For more information about the… |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format (UTC) |
| EndTime | string | no | The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format (UTC). The end time must be later than the start… |
| RegionId | string | yes | The region in which the cluster resides |
| ResourcePools | string | no | The name of the resource group |

### Queries the monitoring information about resource groups within an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbcluster-resource-pool-performance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the information about all… |
| Key | string | no | The metrics of the resource group. You can enter multiple metrics at the same time to query the monitoring information. Separate multiple… |
| ResourcePools | string | no | The names of the resource groups that you want to query. You can enter multiple names of resource groups. Separate multiple names with… |
| StartTime | string | yes | The beginning of the time range to monitor the resource group. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format.… |
| EndTime | string | yes | The end of the time range to monitor the resource group. The end time must be later than the start time. Specify the time in the ISO 8601… |

### Queries the SSL configurations of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbcluster-ssl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/612293.html operation to query the most recent… |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the IDs of all AnalyticDB for… |

### Queries the number of shards in an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbcluster-shard-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent region list |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the IDs of all AnalyticDB for… |

### Queries the storage overview information of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbcluster-space-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |

### Queries the status of AnalyticDB for MySQL Data Warehouse Edition clusters within a region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbcluster-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |

### Queries Data Warehouse Edition clusters
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbclusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the region IDs of available regions |
| DBClusterIds | string | no | The cluster IDs. You can enter any cluster ID in the specified region |
| DBClusterDescription | string | no | The cluster description. It cannot start with `http://` or `https://`. It must be 2 to 256 characters in length |
| DBClusterStatus | string | no | The cluster status. Valid values: Preparing: preparing Creating: creating Restoring: restoring from a backup Running: running Deleting:… |
| PageSize | integer | no | The number of entries per page. Valid values: 30 (default) 50 100 |
| PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1 |
| ResourceGroupId | string | no | The resource group ID |
| Tag | string | no | The list of tags (JSON-encoded) |
| DBVersion | string | no | The cluster version. Set the value to 3.0 |
| DBClusterVersion | string | no | The cluster edition. Valid values: 3.0: Data Warehouse Edition. 5.0 (default): Data Lakehouse Edition, Enterprise Edition, and Basic… |

### Queries the information about a resource group for an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbresource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| GroupName | string | no | The name of the resource group |

### Queries the information about resource groups of an AnalyticDB for MySQL cluster. You can call this…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-dbresource-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| PoolName | string | no | The name of the resource group |

### Queries the deduplicated statistics of SQL statements that meet a condition of the resource group, database,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-diagnosis-dimensions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| StartTime | string | yes | The beginning of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January… |
| EndTime | string | yes | The end of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1,… |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |
| QueryCondition | string | yes | The query condition for SQL statements, which can be a combination of the `Type` and `Value` fields or a combination of the Type, `Min`,… |
| Lang | string | no | The language of file titles and error messages. Valid values: zh (default): simplified Chinese. en: English. ja: Japanese. zh-tw:… |

### Queries the monitoring information about queries within a time range
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-diagnosis-monitor-performance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| StartTime | string | yes | The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| EndTime | string | yes | The end of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January… |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |
| QueryCondition | string | yes | The query conditions for SQL statements, which can be a combination of the `Type` and `Value` fields or a combination of the Type, `Min`,… |
| Lang | string | no | The language of file titles and error messages. Valid values: zh (default): simplified Chinese. en: English. ja: Japanese. zh-tw:… |

### Queries the diagnostic information about SQL statements that meet a condition in an AnalyticDB for MySQL…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-diagnosis-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the information about all… |
| StartTime | string | yes | The beginning of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January… |
| EndTime | string | yes | The end of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1,… |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |
| QueryCondition | string | yes | The query condition for SQL statements, which can contain the `Type`, `Value`, and `Min` or `Max` fields. Specify the condition in the… |
| Keyword | string | no | The keyword for the query |
| MinPeakMemory | integer | no | The minimum peak memory of the SQL statements. Unit: bytes |
| MaxPeakMemory | integer | no | The maximum peak memory of the SQL statements. Unit: bytes |
| MinScanSize | integer | no | The minimum scan size of the SQL statements. Unit: bytes |
| MaxScanSize | integer | no | The maximum scan size of the SQL statements. Unit: bytes |
| ResourceGroup | string | no | The resource group to which the SQL statements belong. You can call the https://help.aliyun.com/document_detail/308210.html operation to… |
| UserName | string | no | The username that is used to execute the SQL statements. You can call the https://help.aliyun.com/document_detail/308210.html operation to… |
| Database | string | no | The database on which the SQL statements are executed. You can call the https://help.aliyun.com/document_detail/308210.html operation to… |
| ClientIp | string | no | The source IP address. You can call the https://help.aliyun.com/document_detail/308210.html operation to query the resource group,… |
| Order | string | no | The order in which to sort the retrieved SQL statements by field. Specify this value in the JSON format. The value is an ordered array… |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Valid values: 30, 50, and 100. Default value: 30 |
| Lang | string | no | The language of file titles and error messages. Valid values: zh (default): simplified Chinese. en: English. ja: Japanese. zh-tw:… |
| PatternId | string | no | The SQL pattern ID. You can call the https://help.aliyun.com/document_detail/321868.html operation to query the information about all SQL… |

### Retrieves the execution details of an SQL statement, including the execution plan, runtime information,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-diagnosis-sqlinfo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the ID of an AnalyticDB for MySQL… |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the region IDs supported by… |
| ProcessId | string | yes | The query ID. You can call the https://help.aliyun.com/document_detail/308207.html operation to query the SQL statement summary of a… |
| ProcessStartTime | integer | no | The start time of the SQL statement execution. The time is a UNIX timestamp in milliseconds. You can call the… |
| ProcessState | string | no | The status of the SQL statement. Valid values: running: Running. finished: Completed. failed: Failed. You can call the… |
| Lang | string | yes | The language of the downloaded file title and some error messages. Valid values: zh: Simplified Chinese. en: English. ja: Japanese. zh-tw:… |
| ProcessRcHost | string | no | The IP address and port of the AnalyticDB for MySQL frontend node that executes the SQL statement. You can call the… |

### Queries the execution information about distributed tasks in a stage of a query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-diagnosis-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the IDs of all AnalyticDB for… |
| RegionId | string | no | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |
| ProcessId | string | yes | The query ID. You can call the https://help.aliyun.com/document_detail/190092.html operation to query the IDs of queries that are being… |
| StageId | string | yes | The ID of a stage in the query that is specified by the `ProcessId` parameter |
| Order | string | no | The order in which to sort the tasks by field. Specify the value in the JSON format. Example: `[{"Field":"CreateTime", "Type":"desc"}]`.… |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page. Valid values: 30 (default) 50 100 |
| State | string | no | The state of the asynchronous import or export task to be queried. Valid values: RUNNING FINISHED FAILED |
| Host | string | no | The IP address from which the query was initiated |

### Queries a list of download tasks for the last five SQL queries of an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-download-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the IDs of all AnalyticDB for… |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |
| Lang | string | no | The language of file titles and error messages. Valid values: zh (default): simplified Chinese. en: English. ja: Japanese. zh-tw:… |

### You can call the DescribeEIURange operation to query the range of elastic I/O units (EIUs) available for a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-eiurange` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| DBClusterId | string | no | The ID of the Data Lakehouse Edition cluster. This parameter can be left empty when Operation is set to Buy. This parameter is required… |
| ComputeResource | string | no | The specifications of the compute resources. Call the https://help.aliyun.com/document_detail/469002.html operation to query the… |
| Operation | string | no | The operation type. Valid values: Buy: Purchase a cluster. Modify: Change the specifications of a cluster |
| RegionId | string | yes | The region ID. Call the https://help.aliyun.com/document_detail/143074.html operation to query the region ID of the cluster |
| DBClusterVersion | string | no | The cluster version. Valid values: 3.0 (default): Data Lakehouse Edition. 5.0: includes Data Lakehouse Edition, Enterprise Edition, and… |
| ZoneId | string | no | The zone ID. Call the https://help.aliyun.com/document_detail/612293.html operation to query the zone ID of the cluster |
| StorageSize | string | no | The specifications of the storage resources. The default value is 8ACU. Valid values: 8ACU 12ACU 16ACU |
| SubOperation | string | no | The sub-operation type. Valid values: Upgrade: Upgrade a cluster. Downgrade: Downgrade a cluster |
| ProductVersion | string | no | The edition. Valid values: EnterpriseVersion: Enterprise Edition. BasicVersion: Basic Edition |

### You can call DescribeElasticDailyPlan to query the execution information of a daily time-based scaling plan.…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-elastic-daily-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster. Call https://help.aliyun.com/document_detail/129857.html to query the IDs of all Data… |
| ElasticPlanName | string | no | The name of the scaling plan. The name must meet the following requirements: It must be 2 to 30 characters in length. It must consist of… |
| ResourcePoolName | string | no | The name of the resource group. Call https://help.aliyun.com/document_detail/466685.html to query the name of the resource group |
| ElasticDailyPlanDay | string | no | The start date of the daily scaling plan. Specify the date in the yyyy-MM-dd format |
| ElasticDailyPlanStatusList | string | no | The execution status of the daily scaling plan. To query multiple statuses, separate them with commas (,). Valid values: 1: Not executed.… |

### Queries scaling plans of an AnalyticDB for MySQL cluster. This operation can be used only for AnalyticDB for…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-elastic-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| ElasticPlanName | string | no | The name of the scaling plan. The name must be 2 to 30 characters in length. The name can contain letters, digits, and underscores (_). If… |
| ResourcePoolName | string | no | The name of the resource group. You can call the https://help.aliyun.com/document_detail/466685.html operation to query the resource group… |
| ElasticPlanEnable | string | no | Specifies whether the scaling plan takes effect. Valid values: true (default) false |

### Queries the tables that have excessive primary key fields in an AnalyticDB for MySQL Data Warehouse Edition…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-excessive-primary-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the IDs of all AnalyticDB for… |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/454314.html operation to query the most recent… |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… |
| EndTime | string | no | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC |
| PageSize | integer | no | The number of entries per page. Valid values: 30 (default) 50 100 |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| Lang | string | no | The display language of the suggestion. Valid values: zh (default): simplified Chinese. en: English. ja: Japanese. zh-tw: traditional… |
| Order | string | no | The order by which to sort query results. Specify the parameter value in the JSON format. Example:… |

### Queries the diagnostic results of the compute layer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-executor-detection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/454250.html operation to query the information about all… |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent region list |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| EndTime | string | no | The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later… |
| Lang | string | no | The language. Valid values: zh: simplified Chinese. en: English |

### Queries historical events from the autonomy center
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-history-events-stat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| ProductId | string | no | The product ID |
| ArchiveStatus | string | no | The event status. Valid values: Archived: Archived. UnArchived: Not archived. All: All events |
| FromStartTime | string | no | The beginning of the time range for the task start time. Only tasks that started after this time are queried. Specify the time in the ISO… |
| ToStartTime | string | no | The end of the time range for the task start time. Only tasks that started before this time are queried. Specify the time in the ISO 8601… |

### Queries the disk usage of all storage nodes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-inclined-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent region list |
| Lang | string | no | The language of file titles and error messages. Valid values: zh: simplified Chinese. en: English. ja: Japanese. zh-tw: traditional Chinese |

### Queries the monitoring information of tables
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-inclined-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster |
| TableType | string | yes | The table type. Valid values: FactTable: partitioned table DimensionTable: dimension table |
| Order | string | no | The sort order of the results. The value must be an ordered JSON array. Specify the fields and the sort order in sequence. Example: ``` [… |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: 1 |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the regions and zones supported by… |
| Lang | string | no | The language of the request and response. Default value: zh. Valid values: zh: Chinese en: English |

### Queries the information about the minor version of an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-kernel-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/98094.html operation to query the information about all… |
| RegionId | string | no | The region ID of the cluster. You can call the DescribeRegions operation to query the most recent region list |

### Queries the list of user KMS keys
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-kms-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| ZoneId | string | no | The zone ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the zone ID |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/612393.html operation to query the region ID of the cluster |

### Queries the details of asynchronous import and export tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-load-tasks-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the region IDs supported by a… |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the details of all Data Warehouse… |
| StartTime | string | yes | The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC). Set the query start time to a point… |
| EndTime | string | yes | The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format… |
| DBName | string | no | The name of the database involved in the import or export task |
| PageSize | integer | no | The number of records per page. Valid values: 30 (default). 50. 100 |
| PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1 |
| Order | string | no | Sorts tasks in ascending or descending order based on a specified field. The value must be a JSON string. Example:… |
| State | string | no | The status of the asynchronous import or export task to query. Valid values: INIT: The task is being initialized. RUNNING: The task is… |

### Queries the details of an SLA system link
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-log-hub-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster |
| ProjectName | string | yes | The name of the log project |
| DeliverName | string | yes | The delivery name |
| LogStoreName | string | yes | The name of the Logstore |

### Queries keywords in a log store
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-log-store-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query region IDs |
| ProjectName | string | yes | The name of the log project |
| LogStoreName | string | yes | The name of the Log Service LogStore |

### Queries the details of log collection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-loghub-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| RegionId | string | yes | The region ID |
| ProjectName | string | yes | The name of the log project |
| ExportName | string | yes | The name of the Simple Log Service delivery task |

### Queries the information about O\&M events
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-maintenance-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| Region | string | yes | The region ID. Valid values: The ID of the region where the O\&M event occurs. Example: `cn-hangzhou`. You can call the… |
| TaskType | string | yes | The type of the O\&M event. Valid values: rds_apsaradb_upgrade: database software upgrades. all: all the O\&M events in all regions within… |
| IsHistory | integer | no | Specifies whether to return the information about pending or historical O\&M events. Valid values: 0: returns the information about… |
| PageSize | integer | no | The number of entries per page. Valid values: 30, 50, and 100. Default value: 30 |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| RegionId | string | yes | The ID of the region where the O\&M event occurs. You can call the https://help.aliyun.com/document_detail/143074.html operation to query… |

### Queries the details of the permissions granted to the service account of an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-operator-permission` (byok)

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

### Queries information about oversized non-partitioned tables
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-oversize-non-partition-table-infos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID |
| StartTime | string | no | The start time of the query. The time is in UTC. Format: yyyy-MM-ddTHH:mm:ssZ |
| EndTime | string | no | The end time of the query. The time is in UTC. Format: yyyy-MM-ddTHH:mm:ssZ |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number |
| Lang | string | no | The language of the file title for downloaded files and specific error messages. Valid values: zh: Simplified Chinese. en: English. ja:… |
| Order | string | no | Sorts the query results by a specified field. The value is a JSON string. Example: `[{"Field":"SchemaName","Type":"Desc"}]`. Parameters:… |

### Queries the metrics of an SQL pattern such as the query duration and average memory usage within a period of…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-pattern-performance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the information about all… |
| StartTime | string | yes | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… |
| EndTime | string | yes | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.… |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |
| PatternId | string | yes | The SQL pattern ID. You can call the https://help.aliyun.com/document_detail/321868.html operation to query the information about all SQL… |

### Queries the running queries on an instance by calling the DescribeProcessList operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-process-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| ShowFull | string | no | Specifies whether to display the full SQL statement. Valid values: True: Displays the full SQL statement. False: Displays only the first… |
| RunningTime | integer | no | Filters queries by running time and displays queries whose running time is greater than the specified value. Unit: seconds |
| User | string | no | Filters queries by username |
| Keyword | string | no | The filter keyword. Currently, only SELECT is supported |
| Order | string | no | Sorts results by the specified field. The value is in JSON format: `[{"Field":"Time","Type":"Desc" },{ "Field":"User", "Type":"Asc" }]`.… |
| PageSize | integer | no | The number of entries per page. Valid values: 30 (default) 50 100 |
| PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1 |

### Queries the information about specifications of MySQL analytic instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-rds-analysis-resource-quotas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| RdsInstanceId | string | no | The ID of the ApsaraDB RDS instance from which data is synchronized to the MySQL analytic instance |
| NodeClass | string | no | The instance type of the MySQL analytic instance |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent region list |
| ClusterCategory | string | no | The edition of the MySQL analytic instance |
| NodeCount | integer | no | The number of nodes in the MySQL analytic instance |
| ClusterMode | string | no | The mode of the MySQL analytic instance |
| StorageType | string | no | The storage type of the MySQL analytic instance |

### Queries a list of available regions and zones for AnalyticDB for MySQL
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| AcceptLanguage | string | no | Th language of the `LocalName` response parameter. Valid values: zh-CN: Chinese. en-US: English. ja: Japanese. If you do not specify this… |
| RegionId | string | no | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/612293.html operation to query the most recent… |

### Queries information about regions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-regions-mixed` (byok)

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

### Query resubmission configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-resubmit-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition (V3.0) cluster. You can call the https://help.aliyun.com/document_detail/129857.html operation to… |
| GroupName | string | yes | The name of the resource group. You can call the https://help.aliyun.com/document_detail/459446.html operation to query the name of the… |

### Call the DescribeSQAConfig operation to query the Short Query Acceleration (SQA) configuration for a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-sqaconfig` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. Call the https://help.aliyun.com/document_detail/143074.html operation to query the region IDs supported by AnalyticDB for… |
| ResourceGroupId | string | no | The resource group ID |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL cluster. Call the https://help.aliyun.com/document_detail/129857.html operation to query the IDs of… |
| GroupName | string | yes | The name of the resource group. Call the https://help.aliyun.com/document_detail/612410.html operation to query information about the… |

### Queries the SQL patterns in an AnalyticDB for MySQL cluster within a specified date range
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-sqlpatterns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the details of all AnalyticDB for… |
| StartTime | string | yes | The start time of the query. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time). You can only query data from the last 14 days. For example, if the… |
| EndTime | string | yes | The end time of the query. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time). The end time must be later than the start time |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the regions and zones supported by… |
| Keyword | string | no | The SQL keyword |
| Order | string | yes | Sorts the query results by a specified field. The format is a JSON character string. Example:… |
| PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. If you do not… |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 If you do not specify this parameter, the default value is 30 |
| Lang | string | no | Specifies the language for the title of the downloaded file and some error messages. Valid values: zh: Simplified Chinese (default). en:… |
| UserName | string | no | The username |
| SqlPatternHash | integer | no | The hash value of the SQL pattern, which is used to filter a specific SQL pattern |

### Queries the plan information about an SQL statement such as a query statement or an extract-transform-load…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-sqlplan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the information about all… |
| ProcessId | string | yes | The query ID. You can call the https://help.aliyun.com/document_detail/612277.html operation to query the IDs of queries that are being… |

### Queries the information about a task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-sqlplan-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| ProcessId | string | yes | The task ID |
| StageId | string | yes | The stage of the task |

### Queries a list of databases in an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-schemas` (byok)

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

### Queries the details of slow query logs for an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-slow-log-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. Call the https://help.aliyun.com/document_detail/129857.html… |
| StartTime | string | yes | The start of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC |
| EndTime | string | yes | The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The end time must be… |
| DBName | string | no | The name of the database |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 30 (default), 50, and 100 |
| PageNumber | integer | no | The page number. The value must be an integer that is greater than 0. Default value: 1 |
| ProcessID | string | no | The process ID |
| Order | string | no | The sorting order of the results. The value is an ordered JSON array. The results are sorted in the order of the objects in the array.… |
| Range | string | no | Filters the results by a specified range based on the maximum (`Max`) and minimum (`Min`) values of a field. The value is a JSON array.… |
| State | string | no | The query state. Valid values: Successed: The query was successful. Failed: The query failed |

### Queries a list of SQL patterns for an AnalyticDB for MySQL cluster within a time range
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-sql-pattern` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| StartTime | string | no | The start date to query. Specify the time in the yyyy-MM-dd format. The time must be in UTC. Only data within the last 30 days can be… |
| Order | string | no | The order by which to sort query results. Specify the parameter value in the JSON string format. Example:… |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| SqlPattern | string | no | The keyword that is used for the query. If you do not specify this parameter, all SQL patterns of the AnalyticDB for MySQL cluster within… |
| Type | string | no | The dimension by which to aggregate the SQL patterns. Valid values: `user`: aggregates the SQL patterns by user. `accessip`: aggregates… |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the information about all… |
| PageSize | integer | no | The number of entries per page. The value must be a positive integer. Default value: 30 |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |

### Queries a list of instances or clusters that are available for data synchronization
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-sync-available-dbcluster-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| RegionId | string | yes | The region ID |
| QueryType | string | yes | The query type. Valid values: Target Source |
| SourceDBCluster | string | no | The source instances or clusters (JSON-encoded) |
| SyncPlatform | string | no | The synchronization platform |

### Queries a list of synchronization jobs in an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-sync-job-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent region list |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/129857.html… |
| SourceDBType | string | no | The source database type |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| SourceDBClusterId | string | no | The ID of the source cluster. You can call the https://help.aliyun.com/document_detail/170879.html operation to query backup set IDs. If… |
| SourceDBClusterDescription | string | no | The description of the source cluster |
| GetSourceDetail | string | no | Specifies whether to obtain details about the source instance or cluster |

### Queries the access count of a specified table or all tables in an AnalyticDB for MySQL cluster on a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-table-access-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the details of all AnalyticDB for… |
| TableName | string | no | The name of the table. If you leave this parameter empty, the access counts of all tables in the cluster on the specified date are returned |
| StartTime | string | yes | The date to query, in the yyyy-MM-dd format (UTC). You can only query data within the last 30 days |
| Order | string | no | Sorts the query results by a specified field. The value must be a JSON string. Example: `[{"Field":"TableSchema","Type":"Asc"}]`.… |
| PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: 1 |
| PageSize | integer | no | The number of entries per page. The value must be a positive integer. Default value: 30 |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the regions and zones supported by… |

### Queries the data distribution of a table in each shard
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-table-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/454250.html operation to query the cluster ID |
| SchemaName | string | yes | The database name |
| TableName | string | yes | The table name |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/612393.html operation to query the region ID |

### Queries the information about partition diagnostics
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-table-partition-diagnose` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the cluster |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| Order | string | no | The order by which to sort query results. Specify the parameter value in the JSON string format. Example:… |
| RegionId | string | no | The region ID |
| Lang | string | no | The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese. en: English |

### Retrieves table statistics from a specified AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-table-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. Call the https://help.aliyun.com/document_detail/129857.html operation to query the cluster ID |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 30 (default) 50 100 |
| PageNumber | integer | no | The page number. The value must be a positive integer. Default value: 1 |
| Order | string | no | The sorting rule for the returned results. The value is a JSON array that is ordered by the sequence of the elements in the array. Each… |
| RegionId | string | no | The region ID. Call the https://help.aliyun.com/document_detail/143074.html operation to query the region ID |
| Keyword | string | no | The keyword for the query. Fuzzy search by table name is supported |
| SchemaName | string | no | The database name |

### Queries a list of tables in a database of an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster |
| SchemaName | string | yes | The name of the database |

### Queries the information about a task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-task-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| TaskId | integer | yes | The task ID |

### Queries the vSwitches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-vswitches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent region list |
| VpcId | string | no | The virtual private cloud (VPC) ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the VPC ID |
| ZoneId | string | no | The zone ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the most recent zone list |
| VswId | string | no | The vSwitch ID |

### Queries a list of available vSwitches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-vswitchs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent region list |
| VpcId | string | no | The virtual private cloud (VPC) ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the VPC ID |
| ZoneId | string | no | The zone ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the most recent zone list |

### Queries a list of available virtual private clouds (VPCs)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-vpcs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| ZoneId | string | no | The zone ID |
| VpcId | string | no | The VPC ID |

### Queries the diagnostic results of the storage layer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/describe-worker-detection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/129857.html… |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent region list |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in… |
| EndTime | string | no | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.… |
| Lang | string | no | The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese. en: English |

### Detaches an elastic network interface (ENI) from an AnalyticDB for MySQL Data Warehouse Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/detach-user-eni` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |

### Disables the suggestion feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/disable-advice-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the IDs of all AnalyticDB for… |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent region list |

### Downloads the diagnostic information about SQL statements that meet a condition for an AnalyticDB for MySQL…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/download-diagnosis-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the information about all… |
| StartTime | string | yes | The beginning of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January… |
| EndTime | string | yes | The end of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1,… |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |
| QueryCondition | string | yes | The query condition for SQL statements, which can be a combination of the `Type` and `Value` fields or a combination of the Type, `Min`,… |
| Keyword | string | no | The keyword that is used for the query |
| MinPeakMemory | integer | no | The minimum peak memory of the SQL statements. Unit: bytes |
| MaxPeakMemory | integer | no | The maximum peak memory of the SQL statements. Unit: bytes |
| MinScanSize | integer | no | The minimum scan size of the SQL statements. Unit: bytes |
| MaxScanSize | integer | no | The maximum scan size of the SQL statements. Unit: bytes |
| ResourceGroup | string | no | The resource group to which the SQL statements belong. You can call the https://help.aliyun.com/document_detail/308210.html operation to… |
| UserName | string | no | The username that is used to execute the SQL statements. You can call the https://help.aliyun.com/document_detail/308210.html operation to… |
| Database | string | no | The name of the database on which the SQL statements are executed. You can call the https://help.aliyun.com/document_detail/308210.html… |
| ClientIp | string | no | The source IP addresses. You can call the https://help.aliyun.com/document_detail/308210.html operation to query the resource group,… |
| Lang | string | no | The language of file titles and error messages. Valid values: zh (default): simplified Chinese. en: English. ja: Japanese. zh-tw:… |

### Enables the suggestion feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/enable-advice-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the IDs of all AnalyticDB for… |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |

### Queries the table creation statement for tables
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/get-create-table-sql` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/129857.html operation to query the IDs of all AnalyticDB for… |
| RegionId | string | yes | The region ID |
| SchemaName | string | no | The name of the database |
| TableName | string | no | The name of the table |

### Grants permissions to the service account of an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/grant-operator-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| ExpiredTime | string | yes | The expiration time of the service account permissions. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The… |
| Privileges | string | yes | The name of the permissions. Valid values: Control: configuration permissions. The service account is granted permissions to query and… |

### Terminates a running task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/kill-process` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| ProcessId | string | no | The unique identifier of the task to be terminated, which is returned by the https://help.aliyun.com/document_detail/190092.html operation |

### Queries the tags that are added to AnalyticDB for MySQL clusters, or the AnalyticDB for MySQL clusters that…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |
| ResourceType | string | yes | The type of the resource. Set the value to cluster |
| NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the… |
| ResourceId | string | no | The cluster ID. You can specify multiple cluster IDs. Valid values of N: 1 to 50. You must specify at least one of the following… |
| Tag | string | no | The tags that are added to clusters (JSON-encoded) |

### Migrates a Data Warehouse Edition cluster to a Data Lakehouse Edition or Enterprise Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/migrate-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster |
| ComputeResource | string | no | The reserved compute resources. Valid values: 0 ACU to 4096 ACU. Step size: 16. 1 ACU is approximately equal to 1 core and 4 GB of memory.… |
| StorageResource | string | no | The reserved storage resources. Valid values: 0 ACU to 2064 ACU. The step size is equal to the number of ACUs specified by the… |
| StorageResourceSize | string | no | The node specifications for reserved storage resources. Valid values: 8 ACU, 12 ACU, and 16 ACU. You must include the unit when you… |
| ShardNumber | string | no | The number of shards. Specifies the number of shards for the instance after the migration. Specify this parameter only when ProductForm is… |
| ReservedNodeSize | string | no | The node specifications for reserved storage resources. Valid values: 8 ACU, 12 ACU, and 16 ACU. You must include the unit when you… |
| ReservedNodeCount | integer | no | The number of reserved nodes. For Enterprise Edition, the default value is 3 and the step size is 3. For Basic Edition, the default value… |
| ProductVersion | string | no | The product edition. Valid values: BasicVersion: Basic Edition EnterpriseVersion: Enterprise Edition Specify this parameter only when… |
| ProductForm | string | no | The product form. Valid values: IntegrationForm: Integration form LegacyForm: Data Lakehouse Edition |
| SecondaryZoneId | string | no | The ID of the secondary zone. This parameter cannot be the same as the ZoneId parameter |
| SecondaryVSwitchId | string | no | The ID of the secondary vSwitch. This parameter cannot be the same as the VSwitchId parameter |
| DryRun | string | no | Specifies whether to only precheck the request. Default value: false. Valid values: true: Sends a check request to verify whether the… |

### Modifies the description of a database account for an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/modify-account-description` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| AccountName | string | yes | The name of the database account |
| AccountDescription | string | yes | The description of the account. The description must meet the following requirements: The description must start with a letter. The… |

### Updates the time configuration for O&M events
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/modify-active-operation-maintain-conf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| CycleType | string | no | The cycle type. Valid values: Week |
| CycleTime | string | no | The day of the week. Valid values: 1 to 7 |
| MaintainStartTime | string | no | The start time. Format: HH:mm:ssZ |
| MaintainEndTime | string | no | The end time. Format: HH:mm:ssZ |
| Status | integer | no | Specifies whether the feature is enabled. Valid values: 1: Enabled. 0: Disabled |

### Changes the execution time of O\&M events
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/modify-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| Ids | string | no | The ID of the O\&M event |
| SwitchTime | string | no | The time from which you want to execute the O\&M event |
| ImmediateStart | integer | no | Specifies whether to immediately execute the O\&M event. Valid values: 1: immediately executes the O\&M event. 0: executes the O\&M event… |

### You can call the ModifyAuditLogConfig operation to modify the audit log settings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/modify-audit-log-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to view available region IDs |
| AuditLogStatus | string | yes | The status of the SQL audit feature. Valid values: on: Enable SQL audit. off: Disable SQL audit |

### Modifies the auto-renewal status of a subscription AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/modify-auto-renew-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. You can call the… |
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/143074.html operation to query the most recent… |
| RenewalStatus | string | no | The renewal status of the cluster. Valid values: AutoRenewal: The cluster is automatically renewed. Normal: The cluster is manually… |
| Duration | string | no | The renewal duration. Default value: 1. Valid values when PeriodUnit is set to Month: 1 to 11. Valid values when PeriodUnit is set to… |
| PeriodUnit | string | no | The unit of the renewal duration. Default value: Month. Valid values: Year Month |

### Modifies the backup policy of an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/modify-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the cluster |
| PreferredBackupTime | string | yes | The start time of the full backup within a time range. Specify the time range in the HH:mmZ-HH:mmZ format. The time must be in UTC. The… |
| PreferredBackupPeriod | string | no | The days of the week on which to perform full backup. Separate multiple values with commas (,). Valid values: Monday Tuesday Wednesday… |
| BackupRetentionPeriod | string | no | The number of days for which to retain full backup files. Valid values: 7 to 730. If you do not specify this parameter, the default value… |
| EnableBackupLog | string | no | Specifies whether to enable real-time log backup. Valid values: Enable Disable If you leave this parameter empty, the default value Enable… |
| LogBackupRetentionPeriod | integer | no | The number of days for which to retain log backup files. Valid values: 7 to 730. If you do not specify this parameter, the default value 7… |

### Changes the endpoint of an AnalyticDB for MySQL cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/modify-cluster-connection-string` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster. You can call the https://help.aliyun.com/document_detail/129857.html… |
| ConnectionStringPrefix | string | yes | The prefix of the public endpoint. The prefix can contain lowercase letters, digits, and hyphens (-). It must start with a lowercase… |
| CurrentConnectionString | string | yes | The current public endpoint of the AnalyticDB for MySQL Data Warehouse Edition cluster. You can call the… |
| Port | integer | no | The port number. Set the value to 3306 |

### Upgrades or downgrades a Data Warehouse Edition cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/modify-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the Data Warehouse Edition cluster |
| DBNodeGroupCount | string | no | The number of node groups. Valid values: 1 to 200. This parameter is required when Mode is set to Reserver (reserved mode) |
| DBNodeStorage | string | no | The storage space of a node. Valid values: If the node class is C8, valid values are 100 to 1000 GB. If the node class is C8, valid values… |
| DBNodeClass | string | no | The node specifications. Valid values: C8 C32 This parameter is required when Mode is set to Reserver (reserved mode) |
| ModifyType | string | no | The modification type. Valid values: Upgrade: Upgrades the cluster. Downgrade: Downgrades the cluster |
| ExecutorCount | string | no | Not applicable |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/143074.html operation to query available regions |
| StorageResource | string | no | Not applicable |
| ComputeResource | string | no | The compute resource. You can call the https://help.aliyun.com/document_detail/190632.html operation to query available compute resources… |
| ElasticIOResourceSize | string | no | The node specifications for a single node of elastic I/O resources. Valid values: 8Core64GB: If the node specifications for a single node… |
| ElasticIOResource | integer | no | The number of elastic I/O resources. The maximum number of elastic I/O resources that you can purchase varies based on the specification.… |
| DBClusterCategory | string | no | The edition. Valid values: Cluster: Cluster Edition in reserved mode. You can purchase Cluster Edition in reserved mode only in regions in… |
| Mode | string | no | The mode. Valid values: Reserver: reserved mode. Flexible: elastic mode |
| DiskPerformanceLevel | string | no | The performance level (PL) of the cloud disk. Valid values: PL0 PL1 PL2 PL3 |

### Modifies the IP address whitelists of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/modify-dbcluster-access-white-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| SecurityIps | string | yes | The IP addresses that you want to use to modify the IP address whitelist of the cluster. Separate multiple IP addresses with commas (,).… |
| DBClusterIPArrayName | string | no | The name of the IP address whitelist that you want to modify. Default value: Default. The name of an IP address whitelist must be 2 to 32… |
| DBClusterIPArrayAttribute | string | no | The attribute of the IP address whitelist. By default, this parameter is empty. The IP address whitelists that have the hidden attribute… |
| ModifyMode | string | no | The method that you want to use to modify the IP address whitelist. Valid values: Cover: overwrites the IP address whitelist. Append: adds… |

### Modifies the description of an AnalyticDB for MySQL cluster to facilitate the maintenance and management of…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/modify-dbcluster-description` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the cluster |
| DBClusterDescription | string | yes | The description of the cluster. The description cannot start with `http://` or `https`. The description must be 2 to 256 characters in… |

…and 25 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-adb/allocate-cluster-public-connection" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud AnalyticDB for MySQL API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-adb/allocate-cluster-public-connection with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud AnalyticDB for MySQL 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-adb.

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