# Alibaba Cloud Distributed Relational Database Service API

> Alibaba Cloud Distributed Relational Database Service API on Apizie: 107 endpoints (Resets the password of a DRDS database by calling the ChangeAccountPassword operation, Switches the zone of a DRDS instance, Checks whether a DRDS database name is valid, Checks whether a DRDS database supports scaling operations such as smooth scale-out, …) 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-drds/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Distributed Relational Database Service (drds, version 2019-01-23). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Resets the password of a DRDS database by calling the ChangeAccountPassword operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/change-account-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| AccountName | string | yes | The account name |
| Password | string | yes | The new password |

### Switches the zone of a DRDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/change-instance-azone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| OriginAzoneId | string | yes | The original zone ID |
| TargetAzoneId | string | yes | The target zone ID |
| DrdsRegionId | string | yes | The region ID |
| ChangeVSwitch | string | no | Specifies whether to update the vSwitch. Valid values: true: Yes. false: No |
| NewVSwitch | string | no | The ID of the new vSwitch |

### Checks whether a DRDS database name is valid
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/check-drds-db-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The ID of the DRDS instance |
| DbName | string | yes | The name of the DRDS database |

### Checks whether a DRDS database supports scaling operations such as smooth scale-out
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/check-expand-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The DRDS instance ID |
| DbName | string | yes | The name of the database |

### Checks whether SQL audit is enabled for a DRDS logical database by calling the CheckSqlAuditEnableStatus…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/check-sql-audit-enable-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The DRDS instance ID |
| DbName | string | yes | The name of the database |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | no | The database name |
| Encode | string | no | The encoding used by the database |
| Password | string | no | The password used to access the database |
| Type | string | no | The sharding method of the database. Valid values: HORIZONTAL: horizontal sharding, which is commonly known as table and database… |
| DbInstType | string | no | The type of the attached storage. Currently, only RDS is supported |
| DbInstanceIsCreating | string | no | Specifies whether the RDS instances involved in database creation are being created |
| AccountName | string | no | This parameter is used only for vertical partitioning. It specifies the name of an account that has access permissions on the… |
| RdsInstance | string | no | The list of RDS instances (JSON-encoded) |
| RdsSuperAccount | string | no | The list of RDS superuser account information (JSON-encoded) |
| InstDbName | string | no | The list of databases (JSON-encoded) |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| Description | string | yes | The description of the instance. The description must meet the following requirements: It cannot start with http:// or https://. It must… |
| RegionId | string | yes | The region ID |
| ZoneId | string | yes | The zone ID |
| Type | string | yes | The instance type. Only PRIVATE is supported, which indicates a dedicated instance. You can also set this parameter to 1 to indicate a… |
| Quantity | integer | yes | The number of instances to create. Only the value 1 is supported, which indicates that only one instance can be created at a time |
| InstanceSeries | string | yes | The instance edition parameter. Valid values: drds.sn2.4c16g: Starter Edition drds.sn2.8c32g: Standard Edition drds.sn2.16c64g: Enterprise… |
| Specification | string | yes | The instance specification code. The value consists of the instance edition and the specific instance specification. Example:… |
| ClientToken | string | yes | The client token that is used to ensure the idempotence of the request and prevent repeated submissions. The value is generated by the… |
| PayType | string | yes | The billing method. Valid values: drdsPre: subscription. drdsPost: pay-as-you-go. drdsRo: When you create a read-only instance, the… |
| VpcId | string | no | The VPC ID |
| VswitchId | string | no | The vSwitch ID |
| isHa | string | no | Specifies whether the instance is a high-availability instance |
| PricingCycle | string | no | Specifies the billing cycle of the subscription instance. Valid values: year: yearly subscription month: monthly subscription This… |
| Duration | integer | no | The subscription duration of the instance. If PricingCycle is set to year, valid values are 1 to 3. If PricingCycle is set to month, valid… |
| IsAutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: Auto-renewal is enabled. If the instance is purchased on a monthly basis,… |
| MasterInstId | string | no | The instance ID of the primary instance. Specify this parameter only when you create a read-only instance |
| MySQLVersion | integer | no | The MySQL version supported by the instance. Valid values: 5: fully compatible with MySQL 5.x (default) 8: fully compatible with MySQL 8.0… |
| ResourceGroupId | string | no | The resource group ID |

### Creates an instance-level account for a DRDS instance by calling the CreateInstanceAccount operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/create-instance-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| AccountName | string | yes | The account name |
| Password | string | yes | The account password |
| DbPrivilege | string | yes | The list of database access permissions (JSON-encoded) |

### Creates a public IP address for a Distributed Relational Database Service (DRDS) instance by calling the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/create-instance-internet-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| RegionId | string | no | The ID of the region in which the DRDS instance resides |

### Creates an order to purchase an ApsaraDB RDS instance by calling the CreateOrderForRds operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/create-order-for-rds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| Params | string | yes | The JSON-formatted parameters for placing an ApsaraDB RDS order. For more information, see… |

### Calls the CreateShardTask operation to create a sharding task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/create-shard-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| DbName | string | yes | The name of the database |
| SourceTableName | string | yes | The name of the source table |
| TargetTableName | string | yes | The name of the target table |
| TaskType | string | yes | The task type. Valid values: `SHARD_TO_SINGLE`, `SINGLE_TO_SHARD`, and `SHARD_TO_SHARD` |

### Queries whether an instance supports backup and recovery by calling the DescribeBackMenu operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-back-menu` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |

### Queries the list of databases that can be restored by calling the DescribeBackupDbs operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-backup-dbs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The DRDS instance ID |
| PreferredRestoreTime | string | no | The restore point in time used to query restorable databases |
| BackupId | string | no | The ID of the backup set used to query restorable databases |

### Calls the DescribeBackupLocal operation to query binary log settings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-backup-local` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |

### Queries the details of a backup policy by calling the DescribeBackupPolicy operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |

### Calls the DescribeBackupSets operation to query backup set information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-backup-sets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| StartTime | string | yes | The start time of the query. Specify a timestamp in milliseconds |
| EndTime | string | yes | The end time of the query. Specify a timestamp in milliseconds. The end time must be later than the start time |

### Queries the target time to which an instance can be restored by calling the DescribeBackupTimes operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-backup-times` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |

### Queries broadcast tables by calling the DescribeBroadcastTables operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-broadcast-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |
| Query | string | no | The query content |
| PageSize | integer | no | The number of entries per page |
| CurrentPage | integer | no | The current page number |

### Queries the list of databases under a target storage instance by calling the DescribeDbInstanceDbs operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-db-instance-dbs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbInstanceId | string | yes | The ID of the instance to which the storage-layer database belongs |
| AccountName | string | no | The name of the PolarDB-X privileged account. If no privileged account exists, leave this parameter empty. For more information about… |
| Password | string | no | The password of the PolarDB-X privileged account. If no privileged account exists, leave this parameter empty. For more information about… |
| DbInstType | string | no | The database storage type. Valid values: POLARDB and RDS |

### Queries the list of storage-layer instances, such as ApsaraDB RDS or PolarDB instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-db-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| Search | string | no | The instance ID or cluster ID of the storage layer instance |
| DbInstType | string | no | The storage-layer type. Valid values: POLARDB and RDS |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| RegionId | string | no | The region ID |

### Queries the details of a database in an instance by calling the DescribeDrdsDB operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |

### Queries the details of a PolarDB cluster in a DRDS logical database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| DbName | string | yes | The name of the DRDS database |
| DbInstanceId | string | yes | The ID of the PolarDB cluster |

### Queries the IP whitelist of a specified database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-dbip-white-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region in which the instance resides |
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |
| GroupName | string | no | The name of the whitelist group |

### Queries the details of databases in a specified instance by calling the DescribeDrdsDBs operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-dbs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| 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. Valid values: 30, 50, and 100. Default value: 30 |
| RegionId | string | yes | The region ID |

### Queries the details of an ApsaraDB RDS storage instance for a DRDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-db-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance name |
| DbName | string | yes | The database name |
| DbInstanceId | string | yes | The instance ID of the custom ApsaraDB RDS instance |

### Queries the list of ApsaraDB RDS instances associated with a DRDS database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-db-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Queries the list of storage instances by calling the DescribeDrdsDbRdsNameList operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-db-rds-name-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The RegionId |
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |

### Queries the details of a DRDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| RegionId | string | no | The region ID |

### Calls the DescribeDrdsInstanceDbMonitor operation to query performance monitoring data of a database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-instance-db-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | Instance ID of the PolarDB-X instance. Instance ID of the DRDS instance. |
| DbName | string | yes | The name of the database |
| Key | string | yes | The performance monitoring metrics. You can specify multiple metrics in a single request. Separate multiple metrics with commas (,). For… |
| StartTime | integer | yes | The start time. Specify a UNIX timestamp in UTC. Unit: milliseconds |
| EndTime | integer | yes | The end time. Specify a UNIX timestamp in UTC. Unit: milliseconds |
| RegionId | string | no | The region ID |

### Queries incomplete tasks in a DRDS instance by calling the DescribeDrdsInstanceLevelTasks operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-instance-level-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |

### Invokes the DescribeDrdsInstanceMonitor operation to query the details of instance monitoring data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-instance-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| Key | string | yes | The performance monitoring metrics. You can specify multiple metrics in a single request. Separate multiple metrics with commas (,). For… |
| StartTime | integer | yes | The start time of the query. Specify a UNIX timestamp in UTC. Unit: milliseconds |
| EndTime | integer | yes | The end time of the query. Specify a UNIX timestamp in UTC. Unit: milliseconds. If the query time range is less than 1 hour, the data… |
| PeriodMultiple | integer | no | The multiplier for the monitoring data collection period. For example, the default data collection period for each resource monitoring… |
| RegionId | string | no | The region ID |

### Queries the version of a DRDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-instance-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| RegionId | string | no | The region ID |

### Queries a list of DRDS instances by calling the DescribeDrdsInstances operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Type | string | no | The instance type. Valid values: 0: shared instance 1: dedicated instance |
| Description | string | no | The description of the instance |
| Expired | string | no | Specifies whether the instance has expired |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| ResourceGroupId | string | no | The resource group ID. This parameter can be left empty |
| RegionId | string | yes | The region ID |
| Mix | string | no | Specifies whether hybrid queries are supported |
| ProductVersion | string | no | The Edition version number. Valid values: V1 and V2 |
| Tag | string | no | The list of tag properties (JSON-encoded) |

### Invokes the DescribeDrdsParams operation to query the query parameter list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-params` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID |
| ParamLevel | string | yes | The parameter level. Valid values: INSTANCE: instance level DB: database level |
| DbName | string | no | The database name |

### Queries the details of all private custom ApsaraDB RDS instances under a specified PolarDB-X instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-rds-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The ID of the PolarDB-X instance. The ID of the DRDS instance. You can call https://help.aliyun.com/document_detail/139284.html to query… |

### Queries horizontally sharded databases under a PolarDB-X instance by calling the DescribeDrdsShardingDbs…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-sharding-dbs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the PolarDB-X instance |
| DbName | string | yes | The name of the database on the PolarDB-X instance |
| DbNamePattern | string | no | The database name matching pattern |
| PageNumber | integer | no | The current page number |
| PageSize | integer | no | The number of entries per page |

### Queries slow SQL statements of a DRDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-slow-sqls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The RegionId |
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |
| ExeTime | integer | yes | The SQL execution time. Unit: milliseconds (ms) |
| StartTime | integer | yes | The end time of the SQL query. Specify the value as a UNIX timestamp in milliseconds (UTC) |
| EndTime | integer | yes | The start time of the SQL query. Specify the value as a UNIX timestamp in milliseconds (UTC) |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of records per page |

### Queries the SQL audit information of a DRDS instance by calling the DescribeDrdsSqlAuditStatus operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-sql-audit-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |

### Queries the change tasks of an instance by calling the DescribeDrdsTasks operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-drds-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | no | The database name |
| TaskType | string | no | The task type |

### Calls the DescribeExpandLogicTableInfoList operation to query shard keys
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-expand-logic-table-info-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |

### Calls the DescribeHotDbList operation to query the list of databases for hot-spot scale-out
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-hot-db-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The name of the database |

### Queries the time range supported for importing historical SQL data into a database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-inst-db-log-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |

### Queries the names of the SLS project and Logstore used for SQL audit
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-inst-db-sls-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| DbName | string | yes | The name of the database |

### Queries the account information of an instance by calling the DescribeInstanceAccounts operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-instance-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |

### Queries whether the zone can be switched by calling the DescribeInstanceSwitchAzone operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-instance-switch-azone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |

### Queries whether an instance supports network transition by calling DescribeInstanceSwitchNetwork
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-instance-switch-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |

### Calls the DescribePreCheckResult operation to view the pre-check result
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-pre-check-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID |
| TaskId | string | yes | The task ID |

### Queries the performance data of an ApsaraDB RDS instance at the storage layer by calling the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-rdsperformance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | Instance ID of the PolarDB-X instance. Instance ID of the DRDS instance. |
| RdsInstanceId | string | yes | The instance ID of the ApsaraDB RDS instance at the storage layer |
| Keys | string | yes | The performance monitoring metrics. You can specify multiple metrics in a single request. Separate multiple metrics with commas (,). For… |
| StartTime | integer | no | The start time of the query. Specify a UNIX timestamp in UTC. Unit: milliseconds |
| EndTime | integer | no | The end time of the query. Specify a UNIX timestamp in UTC. Unit: milliseconds |
| DbInstType | string | no | The database engine type |

### Queries the sale-related data of the storage layer by calling the DescribeRdsCommodity operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-rds-commodity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| CommodityCode | string | yes | The commodity code |
| OrderType | string | no | The order type |

### Queries the performance details (such as CPU) of ApsaraDB RDS instances by calling the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-rds-performance-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The DRDS instance ID |
| RdsInstanceId | string | yes | The list of ApsaraDB RDS instances (JSON-encoded) |

### Calls DescribeRdsSuperAccountInstances to retrieve the privileged accounts of ApsaraDB RDS instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-rds-super-account-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbInstType | string | no | The type of the database instance. Default value: RDS |
| RdsInstance | string | yes | The list of ApsaraDB RDS instance IDs (JSON-encoded) |

### Queries the status of the table recycle bin by calling the DescribeRecycleBinStatus operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-recycle-bin-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| DbName | string | yes | The name of the database created on the DRDS instance |

### Queries the recyclable tables
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-recycle-bin-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |

### Queries the order details of the current restoration purchase
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-restore-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| PreferredBackupTime | string | no | The backup time |
| BackupMode | string | no | The backup mode. Valid values: logic: logical backup phy: physical backup |
| BackupLevel | string | no | The backup level. Valid values: db: database level instance: instance level |
| BackupDbNames | string | no | The name of the database involved in the backup |
| BackupId | string | no | The backup ID |

### Queries the details of the shard change tool by calling DescribeShardTaskInfo
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-shard-task-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |
| SourceTableName | string | yes | The source table name |
| TargetTableName | string | yes | The target table name |

### Queries the list of flashback tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-sql-flashbak-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |

### Queries table schema information by calling the DescribeTable operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |
| TableName | string | yes | The table name |

### Queries a collection of tables by type by calling the DescribeTableListByType operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-table-list-by-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |
| Query | string | no | The search field |
| PageSize | integer | no | The number of entries per page |
| CurrentPage | integer | no | The current page number |
| TableType | string | yes | The table type |

### Calls the DescribeTables operation to retrieve a list of table information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/describe-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |
| Query | string | no | The query condition. Set this parameter to the instance ID of the target instance |
| PageSize | integer | no | The number of entries per page |
| CurrentPage | integer | no | The current page number |
| RegionId | string | yes | The region ID |

### Calls the DisableSqlAudit operation to cancel SQL audit
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/disable-sql-audit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| DbName | string | yes | The name of the DRDS database |

### Calls the EnableInstanceIpv6Address operation to create an IPv6 address
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/enable-instance-ipv6-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| RegionId | string | no | The ID of the region where the instance resides |

### Enables the SQL audit feature by calling the EnableSqlAudit operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/enable-sql-audit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| DbName | string | yes | The name of the database for which to enable SQL audit |
| IsRecall | string | no | Specifies whether to recall historical SQL statements for auditing |
| RecallStartTimestamp | string | no | The start time of the recall period. The value is a UNIX timestamp in milliseconds |
| RecallEndTimestamp | string | no | The end time of the recall period. The value is a UNIX timestamp in milliseconds. The end time must be later than the start time |

### At this point, the BINLOG of the ApsaraDB RDS instance used by the DRDS database includes the information…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/enable-sql-flashback-match-switch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The name of the target database |

### Restores a deleted logical table
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/flashback-recycle-bin-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The ID of the instance where the table is located |
| DbName | string | yes | The name of the database where the table is located |
| TableName | string | yes | The name of the logical table that you want to restore |

### Calls the GetDrdsDbRdsRelationInfo operation to query the storage instance structure of a database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/get-drds-db-rds-relation-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |

### Queries the labels bound to resources by calling ListTagResources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| ResourceType | string | yes | The resource type. Set this parameter to INSTANCE |
| NextToken | string | no | The pagination token |
| Tag | string | no | The list of labels (JSON-encoded) |
| ResourceId | string | no | The list of resources (JSON-encoded) |

### Calls the ManagePrivateRds operation to manage private custom RDS instances in the storage layer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/manage-private-rds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID of the PolarDB-X instance. The region ID of the DRDS instance. You can call… |
| DrdsInstanceId | string | yes | The ID of the PolarDB-X instance. The ID of the DRDS instance. You can call https://help.aliyun.com/document_detail/139284.html to query… |
| DBInstanceId | string | yes | The ID of the private custom RDS instance in the storage layer. You can call https://help.aliyun.com/document_detail/215526.html to query… |
| RdsAction | string | yes | The following management operations are supported for private custom RDS instances: DescribeDBInstanceAttribute: Queries the details of a… |
| Params | string | no | A JSON string that contains the request parameters and their values to be forwarded to the private custom RDS API operation. All parameter… |

### Calls the ModifyAccountDescription operation to modify the description of an account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/modify-account-description` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| AccountName | string | yes | The account name |
| Description | string | yes | The account description |

### Modifies the permissions of an account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/modify-account-privilege` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| AccountName | string | yes | The account name |
| RegionId | string | no | The region ID |
| DbPrivilege | string | no | The list of database permissions (JSON-encoded) |

### Modifies the description of a Distributed Relational Database Service (DRDS) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/modify-drds-instance-description` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| Description | string | yes | The description of the instance |

### Calls the ModifyDrdsIpWhiteList operation to modify the IP whitelist of a database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/modify-drds-ip-white-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |
| IpWhiteList | string | yes | The modified IP whitelist. Separate multiple IP addresses with commas (,) |
| Mode | string | no | The modification mode. Valid values: `true`: append mode `false`: overwrite mode |
| GroupName | string | no | The whitelist group name |
| GroupAttribute | string | no | The description of the whitelist group |

### Modifies the read and write weights of a PolarDB cluster by calling the ModifyPolarDbReadWeight operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/modify-polar-db-read-weight` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| DbName | string | yes | The name of the database |
| DbNodeIds | string | yes | The list of nodes in the target PolarDB cluster. Nodes from different clusters are separated by commas (,), and nodes within the same… |
| DbInstanceId | string | yes | The ID of the PolarDB cluster |
| Weights | string | yes | The weights corresponding to PolarDB groups. Separate multiple weights with commas (,) |

### Modifies the read and write weights of an ApsaraDB RDS instance by calling the ModifyRdsReadWeight operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/modify-rds-read-weight` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| DbName | string | yes | The name of the database |
| InstanceNames | string | yes | The list of ApsaraDB RDS instances. Separate multiple instances with commas (,) |
| Weights | string | yes | The weight values corresponding to each ApsaraDB RDS instance. Separate multiple weight values with commas (,) |

### Submits a data backup task by calling the PutStartBackup operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/put-start-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| BackupMode | string | no | The backup mode. For more information, see https://help.aliyun.com/document_detail/108631.html. Valid values: phy: fast backup logic:… |
| BackupLevel | string | no | The backup level. Valid values: instance: instance-level backup db: database-level backup |
| BackupDbNames | string | no | The list of databases to back up if you perform a database-level backup. Separate multiple database names with commas (,) |

### After an RDS connection changes, refreshes the DRDS shard connections to ensure connectivity to RDS
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/refresh-drds-atom-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The ID of the DRDS instance |
| DbName | string | yes | The name of the database |

### Ensures instance security
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/release-instance-internet-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| RegionId | string | no | The region in which the instance resides |

### Calls the RemoveBackupsSet operation to delete a backup set
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/remove-backups-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| BackupId | string | yes | The ID of the backup set. You can call the https://help.aliyun.com/document_detail/139331.html operation to query the backup set ID |

### Deletes a database from a DRDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/remove-drds-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance to which the target database belongs |
| DbName | string | yes | The name of the target database |

### Calls the RemoveDrdsDbFailedRecord operation to delete a failed database creation record
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/remove-drds-db-failed-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |

### Calls the RemoveDrdsInstance operation to release a target instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/remove-drds-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |

### Calls the RemoveInstanceAccount operation to delete an instance management account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/remove-instance-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The ID of the DRDS instance |
| AccountName | string | yes | The name of the account |

### Purges a table from the recycle bin
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/remove-recycle-bin-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The name of the DRDS database |
| TableName | string | no | The name of the DRDS logical table |

### Restarts a Distributed Relational Database Service (DRDS) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/restart-drds-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |

### Rolls back the version of a DRDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/rollback-instance-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| RegionId | string | no | The region ID |

### Modifies the backup policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/set-backup-local` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The DRDS instance ID |
| LocalLogRetentionHours | string | no | The number of hours for which log backups are retained locally. Valid values: 0 to 168 (7 × 24). A value of 0 indicates that log backups… |
| LocalLogRetentionSpace | string | no | The maximum space usage of binary logs, in percentage. Valid values: 0 to 50. This is a loop space. Default value: 30 |
| HighSpaceUsageProtection | string | no | Specifies whether to unconditionally clean up binary logs when the instance storage usage is 90% or higher, or the remaining storage is… |

### Sets a backup policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/set-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| PreferredBackupPeriod | string | no | The backup cycle. Valid values: 0: Monday 1: Tuesday 2: Wednesday 3: Thursday 4: Friday 5: Saturday 6: Sunday |
| PreferredBackupStartTime | string | no | The start time of the backup |
| PreferredBackupEndTime | string | no | The end time of the backup |
| BackupMode | string | no | The backup mode. Valid values: logic: logical backup phy: physical backup |
| BackupLevel | string | no | The backup level. Valid values: db: database level instance: instance level |
| BackupDbNames | string | no | The databases to back up. Separate multiple databases with commas (,). This parameter takes effect only when the backup level is set to… |
| BackupLog | string | no | Specifies whether to enable backup logging. Valid values: 1: enabled 0: disabled |
| DataBackupRetentionPeriod | string | no | The number of days for which data backups are retained. Valid values: 7 to 730 |
| LogBackupRetentionPeriod | string | no | The number of days for which log backups are retained. Valid values: 7 to 730. The value must be less than or equal to the data backup… |

### Calls the SetupBroadcastTables operation to set up broadcast tables
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/setup-broadcast-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID of the instance |
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| DbName | string | yes | The name of the DRDS database |
| Active | string | yes | Specifies whether to activate the broadcast table feature |
| TableName | string | yes | The name of the DRDS table (JSON-encoded) |

### Configures the parameters of an instance by calling the SetupDrdsParams operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/setup-drds-params` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID |
| ParamLevel | string | yes | The level at which the parameters are configured. Valid values: NSTANCE: instance level DB: database level |
| Data | string | yes | The list of parameters (JSON-encoded) |

### Calls the SetupRecycleBinStatus operation to enable the table recycle bin
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/setup-recycle-bin-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The DRDS instance ID |
| DbName | string | yes | The database name |
| StatusAction | string | yes | The enabling status of the table recycle bin. Valid values: enable disable |

### Calls the SetupTable operation to enable full table scan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/setup-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The ID of the DRDS instance |
| DbName | string | yes | The name of the database to which the table belongs |
| AllowFullTableScan | string | yes | Specifies whether to allow full table scan |
| TableName | string | yes | The names of the associated tables (JSON-encoded) |

### Starts a backup-based restoration task by calling the StartRestore operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/start-restore` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| PreferredBackupTime | string | no | The restoration time of the instance. The value is in the `yyyy-MM-dd HH:mm:ss` format |
| BackupMode | string | no | The backup mode. Valid values: logic: logical backup phy: fast backup |
| BackupLevel | string | no | The backup level. Valid values: db: database level instance: instance level |
| BackupDbNames | string | no | The list of database names to restore. Separate multiple database names with commas (,). If you do not specify any database names, all… |
| BackupId | string | no | The ID of the DRDS backup set. If you do not specify this parameter, the restoration is performed based on the point in time specified by… |

### Submits a cleanup task for a scaling operation by calling the SubmitCleanTask operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/submit-clean-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| DbName | string | yes | The name of the database to be scaled |
| ParentJobId | string | yes | The task ID of the scaling task. This ID is returned when you submit the scaling task request |
| JobId | string | yes | The job ID of the scaling task. The value is the same as that of ParentJobId |
| ExpandType | string | yes | The scaling type. Valid values: smooth_expand: smooth scale-out hot_expand: hotspot update |

### Performs checks that mainly include checking for table without primary key
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/submit-hot-expand-pre-check-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| DbName | string | yes | The name of the DRDS database |
| DbInstType | string | yes | The type of the database. Valid values: RDS POLARDB |
| TableList | string | no | The table name (JSON-encoded) |

### Calls the SubmitHotExpandTask operation to submit a hotspot scale-out task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/submit-hot-expand-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |
| TaskName | string | no | The task name |
| TaskDesc | string | no | The task description |
| InstanceDbMapping | string | yes | The list of target instance data (JSON-encoded) |
| Mapping | string | yes | The list of target database data (JSON-encoded) |
| SupperAccountMapping | string | no | The list of privileged account data (JSON-encoded) |
| ExtendedMapping | string | yes | The list of scale-out data (JSON-encoded) |

### Submits a smooth scale-out precheck task by calling the SubmitSmoothExpandPreCheck operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/submit-smooth-expand-pre-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The DRDS instance ID |
| DbName | string | yes | The name of the DRDS database |
| DbInstType | string | yes | The type of the database. Valid values: RDS POLARDB |

### Submits a dry run task for smooth scale-out
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/submit-smooth-expand-pre-check-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The ID of the DRDS instance |
| DbName | string | yes | The name of the DRDS database |

### Calls the SubmitSqlFlashbackTask operation to submit an SQL flashback task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/submit-sql-flashback-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The ID of the DRDS instance |
| DbName | string | yes | The name of the DRDS database |
| StartTime | string | yes | The start time for executing the flashback SQL |
| EndTime | string | yes | The end time for executing the flashback SQL |
| TraceId | string | no | The trace ID of the flashback SQL |
| TableName | string | no | The name of the table on which the flashback SQL operation is performed |
| SqlType | string | no | The type of SQL statement. Valid values: INSERT, UPDATE, and DELETE. Separate multiple values with commas (,) |
| SqlPk | string | no | The primary key of the flashback SQL |
| RecallType | integer | no | The match type. Valid values: 0: exact match. 1: fuzzy match |
| RecallRestoreType | integer | yes | The restore type. Valid values: 1: image restore. 0: reverse restore |

### Switches a broadcast table from multi-write mode to asynchronous link mode by calling the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/switch-global-broadcast-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID of the DRDS instance |
| DbName | string | yes | The name of the DRDS database |

### Calls the TagResources operation to add labels to resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| ResourceType | string | yes | The resource type. Set this parameter to INSTANCE |
| Tag | string | yes | The labels (JSON-encoded) |
| ResourceId | string | yes | The resources (JSON-encoded) |

### Calls the UntagResources operation to remove tags from resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| ResourceType | string | yes | The resource type. Set this parameter to INSTANCE |
| All | string | no | Specifies whether to remove all tags from the resources |
| ResourceId | string | yes | The resource ID (JSON-encoded) |
| TagKey | string | no | The key of the tag. N specifies the sequence number of the tag key. For example: * Tag.1.Key specifies the key of the first tag. *… |

### Switches the network type of a DRDS instance by calling the UpdateInstanceNetwork operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/update-instance-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The DRDS instance ID |
| SrcInstanceNetworkType | string | yes | The current network type of the DRDS instance. Valid values: vpc: virtual private cloud (VPC) classic: classic network |
| RetainClassic | string | no | Specifies whether to retain the classic network endpoint |
| ClassicExpiredDays | integer | no | The number of days for classic network address reservation |

### Upgrades or downgrades the specifications of a storage-layer custom ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/update-private-rds-class` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RdsClass | string | no | The specification code of the storage-layer custom ApsaraDB RDS instance after the update. You can call the… |
| DrdsInstanceId | string | yes | The PolarDB-X instance ID. The DRDS instance ID. You can call the https://help.aliyun.com/document_detail/139284.html operation to query… |
| DBInstanceId | string | yes | The ID of the storage-layer custom ApsaraDB RDS instance. > You can call the [DescribeDrdsRdsInstances](~~xxxx~~) operation to query the… |
| Storage | string | no | The storage capacity of the storage-layer custom ApsaraDB RDS instance after the update. You can call the… |
| AutoUseCoupon | string | no | Specifies whether to use vouchers to offset the purchase cost. Valid values: true and false (default). After vouchers are used, if you… |
| PrePayDuration | integer | no | Invalid field |

### Calls the UpdateResourceGroupAttribute operation to transfer an instance to a new resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/update-resource-group-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the target instance. You can call the https://help.aliyun.com/document_detail/139284.html operation to query the details… |
| DrdsInstanceId | string | yes | The ID of the target instance. You can call the https://help.aliyun.com/document_detail/139284.html operation to query the details of… |
| NewResourceGroupId | string | yes | The ID of the target resource group. You can call the https://help.aliyun.com/document_detail/158855.html operation to query the details… |

### Upgrades the version of a DRDS column-oriented calculation instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/upgrade-hi-store-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The DRDS instance ID |
| RegionId | string | no | The region ID |
| HistoreInstanceId | string | yes | The DRDS column-oriented calculation instance ID |

### Upgrades the version of a DRDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/upgrade-instance-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DrdsInstanceId | string | yes | The instance ID |
| RegionId | string | no | The region ID |
| Rpm | string | no | The version number. You do not need to specify this parameter |

### Calls the ValidateShardTask operation to check whether a sharding change task is valid
`POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/validate-shard-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| DrdsInstanceId | string | yes | The instance ID |
| DbName | string | yes | The database name |
| SourceTableName | string | yes | The source table name |
| TargetTableName | string | yes | The target table name |
| TaskType | string | yes | The task type. Valid values: SINGLE_TO_SHARD: converts a single table to a sharded table. SHARD_TO_SINGLE: converts a sharded table to a… |

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

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-drds/change-account-password" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Distributed Relational Database Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-drds/change-account-password with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Distributed Relational Database Service 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-drds.

### What is the status of the Alibaba Cloud Distributed Relational Database Service API?
Needs your own provider key (bring your own key)