# Alibaba Cloud ApsaraDB for RDS API

> Alibaba Cloud ApsaraDB for RDS API on Apizie: 365 endpoints (Performs a cloud migration switchover for an ApsaraDB RDS for PostgreSQL instance and promotes it to the…, Adds instances to a deployment set, Binds tags to one or more instances, Applies for a public endpoint for an ApsaraDB RDS instance, …) 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-rds/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for ApsaraDB for RDS (rds, version 2014-08-15). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Performs a cloud migration switchover for an ApsaraDB RDS for PostgreSQL instance and promotes it to the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/activate-migration-target-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The ID of the target instance. You can invoke the DescribeDBInstances operation to query the instance ID |
| SwitchTime | string | no | The reserved parameter. This parameter does not take effect |
| SwitchTimeMode | string | no | The switchover time mode for cloud migration. Set the value to 0, which specifies an immediate switchover |
| ForceSwitch | string | no | Set the value to 1, which specifies a forced switchover |

### Adds instances to a deployment set
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/add-rcinstances-to-deployment-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID |
| DeploymentSetId | string | yes | The ID of the deployment set |
| RCInstanceIds | string | yes | The instance IDs |
| DeploymentSetGroupNo | string | no | The group number of the instance in the deployment set. This parameter is valid only when the deployment set strategy of the ECS instance… |
| Force | string | no | Specifies whether to forcibly release the running instance. Valid values: true: yes. false (default): no |

### Binds tags to one or more instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/add-tags-to-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | Ensures the idempotence of the request and prevents duplicate requests. The value is generated by the client and must be unique across… |
| proxyId | string | no | The ID of the proxy mode |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query available region IDs |
| DBInstanceId | string | yes | The instance ID. You can specify up to 30 instance IDs for batch operations. Separate multiple instance IDs with commas (,) |
| Tags | string | no | The list of tags to be bound, including TagKey and TagValue. You can specify up to 5 key-value pairs at a time in the following format:… |
| Tag.1.key | string | no | The key of the first tag. The tags to be bound include TagKey and TagValue. You can specify up to 5 key-value pairs at a time. TagKey… |
| Tag.2.key | string | no | The key of the second tag. The tags to be bound include TagKey and TagValue. You can specify up to 5 key-value pairs at a time. TagKey… |
| Tag.3.key | string | no | The key of the third tag. The tags to be bound include TagKey and TagValue. You can specify up to 5 key-value pairs at a time. TagKey… |
| Tag.4.key | string | no | The key of the fourth tag. The tags to be bound include TagKey and TagValue. You can specify up to 5 key-value pairs at a time. TagKey… |
| Tag.5.key | string | no | The key of the fifth tag. The tags to be bound include TagKey and TagValue. You can specify up to 5 key-value pairs at a time. TagKey… |
| Tag.1.value | string | no | The value of the first tag. The tags to be bound include TagKey and TagValue. You can specify up to 5 key-value pairs at a time. TagKey… |
| Tag.2.value | string | no | The value of the second tag. The tags to be bound include TagKey and TagValue. You can specify up to 5 key-value pairs at a time. TagKey… |
| Tag.3.value | string | no | The value of the third tag. The tags to be bound include TagKey and TagValue. You can specify up to 5 key-value pairs at a time. TagKey… |
| Tag.4.value | string | no | The value of the fourth tag. The tags to be bound include TagKey and TagValue. You can specify up to 5 key-value pairs at a time. TagKey… |
| Tag.5.value | string | no | The value of the fifth tag. The tags to be bound include TagKey and TagValue. You can specify up to 5 key-value pairs at a time. TagKey… |
| ResourceGroupId | string | no | The ID of the resource group |

### Applies for a public endpoint for an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/allocate-instance-public-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to query the instance ID |
| ConnectionStringPrefix | string | yes | The prefix of the public endpoint. The complete public endpoint is in the format of `Prefix.DPI engine.rds.aliyuncs.com`. Example:… |
| Port | string | yes | The public port. Valid values: 1000 to 5999 |
| BabelfishPort | string | no | The TDS port number of Babelfish for RDS PostgreSQL. This parameter is applicable only to ApsaraDB RDS for PostgreSQL instances. For more… |
| GeneralGroupName | string | no | The name of the group to which the general-purpose ApsaraDB RDS for MySQL instance in a dedicated cluster belongs |
| PGBouncerPort | string | no | The PgBouncer port. This parameter is applicable only to ApsaraDB RDS for PostgreSQL instances |

### Applies for a read-only endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/allocate-read-write-splitting-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The ID of the primary instance. You can call DescribeDBInstances to query the instance ID |
| ConnectionStringPrefix | string | no | The prefix of the read-only endpoint. The prefix must be unique, can contain lowercase letters and hyphens (-), must start with a letter,… |
| Port | string | no | The port of the read-only endpoint. Valid values: 1000 to 5999. Default value: 1433 |
| MaxDelayTime | string | no | The latency threshold. Valid values: 0 to 7200. Unit: seconds. Default value: 30. When the latency of a read-only instance exceeds this… |
| NetType | string | no | The network type of the read-only endpoint. Valid values: Internet: public endpoint. Intranet: internal endpoint. The default value is… |
| DistributionType | string | no | The mode of read weight distribution. Valid values: Standard: Read weights are automatically assigned based on instance specifications.… |
| Weight | string | no | The read weight distribution, which specifies the ratio of read requests that are routed to the primary instance and read-only instances.… |

### Attaches an EIP to an RDS Custom instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/associate-eip-address-with-rcinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the DescribeRegions operation to query available regions |
| InstanceId | string | no | The RDS Custom instance ID |
| AllocationId | string | no | The ID of the elastic IP address (EIP). If you do not have an EIP, https://help.aliyun.com/document_detail/292841.html first |

### Attaches a pay-as-you-go data cloud disk or a system cloud disk to an RDS Custom instance. The instance and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/attach-rcdisk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the destination RDS Custom instance |
| DiskId | string | yes | The ID of the cloud disk to be attached. The cloud disk (DiskId) and the instance (InstanceId) must be in the same zone |
| DeleteWithInstance | string | no | Specifies whether to release the cloud disk when the instance is released. Valid values: true: The cloud disk is released. false: The… |
| RegionId | string | no | The region ID |

### Adds an RDS Custom instance to an ACK cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/attach-rcinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| VpcId | string | no | The ID of the virtual private cloud (VPC). Reserved parameter |
| InstanceIds | string | yes | The list of instance IDs (JSON-encoded) |
| Password | string | no | The logon password of the RDS Custom instance |
| KeyPair | string | no | The key pair of the RDS Custom instance |

### Associates a whitelist template with an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/attach-whitelist-template-to-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| TemplateId | integer | yes | The ID of the whitelist template. You can call the DescribeAllWhitelistTemplate operation to query the ID |
| InsName | string | yes | The name of the instance |
| RegionId | string | no | The region ID. You can call the DescribeRegions operation to query the region ID |
| ResourceGroupId | string | no | The resource group ID. For more information about resource groups, see What is a resource group |

### Creates the AliyunServiceRoleForRdsBackupEncryption service-linked role for backup encryption
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/authorize-backup-encryption` (byok)

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

### Adds rules to a specified security group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/authorize-rcsecurity-group-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| SecurityGroupId | string | no | The security group ID |
| SecurityGroupPermissions | string | no | The security group information (JSON-encoded) |
| Direction | string | no | The rule direction. Valid values: ingress: inbound traffic to the security group. egress: outbound traffic from the security group |

### Queries the system weight allocation values
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/calculate-dbinstance-weight` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | Instance ID of the primary instance. You can call the DescribeDBInstances operation to query instance ID |

### Cancels proactive O&M tasks that have not yet started
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/cancel-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| Ids | string | yes | The list of IDs for batch cancellation. Separate multiple IDs with commas (,). Specify no more than 25 IDs at a time |

### Checks whether a database account name is available for an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/check-account-name-available` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| 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 make… |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to query the instance ID |
| AccountName | string | yes | The name of the account that you want to create |

### Checks whether the backup encryption service-linked role AliyunServiceRoleForRdsBackupEncryption is created…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/check-backup-encryption-authorized` (byok)

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

### Queries the authorization status of an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/check-cloud-resource-authorized` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the DescribeRegions operation to query the region ID |
| DBInstanceId | string | no | The instance ID. You can call the DescribeDBInstances operation to query the instance ID |
| TargetRegionId | string | no | The ID of the destination region. You can call the DescribeRegions operation to query the region ID |
| ResourceGroupId | string | no | The ID of the resource group |

### Checks whether an ApsaraDB RDS instance can be restored across regions by using a cross-region backup set
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/check-create-ddr-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the destination instance. You can call the DescribeRegions operation to query region IDs |
| Engine | string | yes | The type of the destination database engine. Valid values: MySQL SQLServer PostgreSQL |
| EngineVersion | string | yes | The version of the destination database engine. Valid values vary based on the Engine parameter: MySQL: 5.5/5.6/5.7/8.0 SQL Server: 2008r2… |
| DBInstanceClass | string | yes | The instance type of the destination instance. For more information, see https://help.aliyun.com/document_detail/26312.html |
| DBInstanceStorage | integer | yes | The instance storage of the destination instance. Valid values: 5 to 2000. The value increments by 5 GB. Unit: GB. For more information,… |
| RestoreType | string | yes | The restoration method. Valid values: 0 (default): Restoration from a backup set. If you set this parameter to 0, you must also specify… |
| BackupSetId | string | no | The ID of the backup set that is used for restoration from a backup set. You can call the DescribeCrossRegionBackups operation to query… |
| RestoreTime | string | no | The point in time to which you want to restore data. The point in time must be earlier than the current time. Specify the time in the… |
| SourceRegion | string | no | The region ID of the source instance. This parameter is required when RestoreType is set to 1 |
| SourceDBInstanceName | string | no | The ID of the source instance. This parameter is required when RestoreType is set to 1 |
| ResourceGroupId | string | no | The ID of the resource group. You can call the DescribeDBInstanceAttribute operation to query the resource group ID |

### Checks whether a database name is duplicate or does not comply with naming conventions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/check-dbname-available` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| 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 make… |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to query the instance ID |
| DBName | string | yes | The database name to check |

### Queries whether a specified ApsaraDB RDS instance exists
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/check-instance-exist` (byok)

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

### Checks whether the current region supports backup encryption
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/check-region-support-backup-encryption` (byok)

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

### Queries whether a service-linked role (SLR) has been created
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/check-service-linked-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. This parameter does not affect the query result. You can specify any region ID. You can call the DescribeRegions operation… |
| ServiceLinkedRole | string | yes | The service-linked role. For more information about the service-linked roles supported by ApsaraDB RDS, see… |
| ResourceGroupId | string | no | The resource group ID |

### Restores historical data to a new instance, also known as a clone instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/clone-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to… |
| RegionId | string | no | The region ID. You can call the DescribeRegions operation to view the region ID |
| ZoneId | string | no | The primary zone ID. You can call the DescribeRegions operation to view the zone ID. Default value: the zone ID of the source instance |
| DBInstanceClass | string | no | The instance type. For more information, see https://help.aliyun.com/document_detail/26312.html. Default value: the instance type of the… |
| DBInstanceStorage | integer | no | Instance storage capacity of the instance. Unit: GB. Instance storage capacity increases in increments of 5 GB. For more information, see… |
| DBInstanceDescription | string | no | The instance name. It must be 2 to 255 characters in length. It must start with a letter or a Chinese character and can contain letters,… |
| DbNames | string | no | The names of the databases. Format: `Original database name 1,Original database name 2` |
| PayType | string | yes | The billing method of the instance. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription. Serverless: serverless. This value is… |
| InstanceNetworkType | string | no | The network type of the instance. Valid values: VPC: Virtual Private Cloud (VPC). Classic: classic network. Default value: the network… |
| DBInstanceId | string | yes | The instance ID |
| BackupId | string | no | The ID of the backup set. You can call the DescribeBackups operation to query the backup sets. You must specify at least one of the… |
| RestoreTime | string | no | The point in time to which you want to restore the instance. The point in time must be within the backup retention period. Specify the… |
| VPCId | string | no | The VPC ID. Make sure that the VPC belongs to the region where the instance is deployed |
| VSwitchId | string | no | The vSwitch ID. The zone (active zone) where the vSwitch is located must match the zone (active zone) ID specified in ZoneId. The network… |
| PrivateIpAddress | string | no | The internal network IP address of the new instance. The IP address must be within the IP address range of the specified vSwitch. By… |
| UsedTime | integer | no | The subscription duration. Valid values: Valid values when the Period parameter is set to Year: 1, 2, and 3. Valid values when the Period… |
| Period | string | no | The subscription period of the subscription instance. Valid values: Year: yearly subscription. Month: monthly subscription. This parameter… |
| Category | string | no | The instance edition. Valid values: Basic: Basic Edition. HighAvailability: high availability Edition (active). AlwaysOn: Cluster Edition… |
| ZoneIdSlave1 | string | no | The secondary zone (active zone) ID. If this parameter is set to the same value as the ZoneId parameter, the instance uses a single-zone… |
| ZoneIdSlave2 | string | no | The logger zone (active zone) ID. If this parameter is set to the same value as the ZoneId parameter, the instance uses a single-zone… |
| DBInstanceStorageType | string | no | The instance storage type. Valid values: general_essd: Premium ESSD (recommended). local_ssd: premium local disk. cloud_ssd: standard SSD.… |
| RestoreTable | string | no | Specifies whether to restore individual databases and tables. A value of true specifies that individual databases and tables are restored.… |
| TableMeta | string | no | The information about the databases and tables that you want to restore. This parameter is required when you restore individual databases… |
| DedicatedHostGroupId | string | no | The ID of the dedicated cluster |
| BackupType | string | no | The backup type. Valid values: FullBackup: full backup. IncrementalBackup: incremental backup |
| DeletionProtection | string | no | Specifies whether to enable the release protection feature. Valid values: true: enables the feature. false (default): disables the feature |
| ServerlessConfig | string | no | The ServerlessConfig (JSON-encoded) |
| BpeEnabled | string | no | The BpeEnabled |
| IoAccelerationEnabled | string | no | Specifies whether to enable the Buffer Pool Extension (BPE) feature for Premium ESSD cloud disks. Valid values: 1: enables the feature. 0:… |
| BurstingEnabled | string | no | Specifies whether to enable the I/O performance burst feature for Premium ESSD cloud disks. Valid values: true: enables the feature.… |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. Make sure that your account balance is… |
| CustomExtraInfo | string | no | The internal reserved field. You do not need to specify this parameter |
| Tag | string | no | The list of tags (JSON-encoded) |

### Copies an ApsaraDB RDS parameter template to the current region or another region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/clone-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the source parameter template. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the… |
| TargetRegionId | string | yes | The ID of the destination region. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the region ID |
| ParameterGroupId | string | yes | The ID of the source parameter template. You can call the https://help.aliyun.com/document_detail/144491.html operation to query the… |
| ParameterGroupName | string | yes | The name of the parameter template that is copied to the destination region |
| ParameterGroupDesc | string | no | The description of the parameter template that is copied to the destination region |
| ResourceGroupId | string | no | The resource group ID. This parameter can be left empty |

### Confirms the carousel messages in the ApsaraDB RDS console for the Alibaba Cloud account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/confirm-notify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| Confirmor | integer | yes | The Alibaba Cloud account ID of the user who confirms the notification. You can also set this parameter to 0, which indicates that the… |
| NotifyIdList | string | yes | The list of notification IDs (JSON-encoded) |

### Copies a database for an ApsaraDB RDS for SQL Server 2008 R2 instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/copy-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | no | The instance name. This parameter is required |
| SrcDBName | string | no | The source database name. This parameter is required |
| DstDBName | string | no | The destination database name. This parameter is required |
| ReserveAccount | integer | no | The reserved account |
| ResourceGroupId | string | no | The resource group ID |

### Copies a database between ApsaraDB RDS for SQL Server instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/copy-database-between-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The ID of the source instance. You can call the DescribeDBInstances operation to query the instance ID |
| TargetDBInstanceId | string | yes | The ID of the target instance. You can call the DescribeDBInstances operation to query the instance ID |
| DbNames | string | yes | The names of the databases to be copied. Specify the names in the following format: `{"Source database name":"Target database name"}`.… |
| BackupId | string | no | The ID of the backup set of the source instance. When you copy a database based on a backup set, you can call the DescribeBackups… |
| RestoreTime | string | no | The point in time to which you want to restore the database. You can select any point in time within the backup retention period. Specify… |
| SyncUserPrivilege | string | no | Specifies whether to enable the replication of users and permissions. Valid values: YES: Enables the replication of users and permissions.… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/610396.html to query the instance ID |
| AccountName | string | yes | The name of the database account. The name must be unique and can contain uppercase letters (supported only by MySQL), lowercase letters,… |
| AccountPassword | string | yes | The password of the database account. The password must be 8 to 32 characters in length. The password must contain at least three of the… |
| AccountDescription | string | no | The description of the account. The description must be 2 to 256 characters in length. It must start with a letter or a Chinese character… |
| AccountType | string | no | The type of the account. Valid values: Normal (default): standard account. Super: privileged account. You can create at most one… |
| CheckPolicy | string | no | The https://help.aliyun.com/document_detail/2845728.html for the SQL Server instance. Valid values: true: The policy is applied. false:… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to obtain the instance ID |
| DBName | string | no | The list of databases. Separate multiple databases with commas (,). This parameter takes effect only when the BackupStrategy parameter is… |
| BackupStrategy | string | no | The backup strategy. Valid values: db: database-level backup instance: instance-level backup This parameter takes effect only when the… |
| BackupMethod | string | no | The backup method. Valid values: Logical: logical backup (supported only for ApsaraDB RDS for MySQL instances with local SSDs) Physical:… |
| BackupType | string | no | The backup type for ApsaraDB RDS for SQL Server instances. Valid values: Auto (default): automatically selects full backup or incremental… |
| BackupRetentionPeriod | integer | no | SQL Server: When the BackupStrategy parameter is set to db, the BackupMethod parameter is set to Physical, and the BackupType parameter is… |

### Creates a pre-check task for one-click cloud migration of an ApsaraDB RDS for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-cloud-migration-precheck-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The ID of the target instance. You can invoke the DescribeDBInstances operation to query the instance ID |
| SourceIpAddress | string | yes | The internal IP address of the self-managed PostgreSQL database. For the one-click cloud migration scenario of a self-managed PostgreSQL… |
| SourcePort | integer | yes | The port number of the self-managed PostgreSQL database. You can run the `netstat -a / grep PGSQL` command to view the port number |
| SourceAccount | string | yes | The username of the database account. This is the database account created in the https://help.aliyun.com/document_detail/369500.html step |
| SourcePassword | string | yes | The password of the database account. This is the password of the database account created in the… |
| TaskName | string | no | The name of the task. You can specify a custom name. If you do not specify a name, the system automatically generates one |
| SourceCategory | string | yes | The type of the self-managed PostgreSQL database. Valid values: idcOnVpc: a self-managed PostgreSQL database in an on-premises data center… |

### Creates a cloud migration task for ApsaraDB RDS for PostgreSQL
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-cloud-migration-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The instance ID of the destination instance. You can call the DescribeDBInstances operation to query the instance ID |
| SourceIpAddress | string | yes | The internal or public IP address of the self-managed PostgreSQL database. For the one-click cloud migration scenario of a self-managed… |
| SourcePort | integer | yes | The port of the self-managed PostgreSQL database. You can run the `netstat -a / grep PGSQL` command to view the port |
| SourceAccount | string | yes | The username. The database account created in the https://help.aliyun.com/document_detail/369500.html step |
| SourcePassword | string | yes | The password. The password of the database account created in the https://help.aliyun.com/document_detail/369500.html step |
| TaskName | string | no | The name of the task. You can specify a custom name. If you do not specify a name, the system automatically generates one |
| SourceCategory | string | yes | The category of the source instance. Valid values: aliyunRDS: Alibaba Cloud RDS instance. other: Other |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/610399.html operation to query the region ID |
| Engine | string | yes | The database engine. Valid values: MySQL SQLServer PostgreSQL MariaDB |
| EngineVersion | string | yes | The database engine version. Valid values: Regular instances * MySQL: 5.5, 5.6, 5.7, and 8.0 * SQL Server: 08r2_ent_ha (cloud disk… |
| DBInstanceClass | string | yes | The instance type. You can specify a standard or YiTian instance type. For details, see… |
| DBInstanceStorage | integer | yes | Instance storage capacity of the instance. Unit: GB. Instance storage capacity increases in increments of 5 GB. For more information about… |
| SystemDBCharset | string | no | Deprecated. You do not need to configure this parameter |
| DBInstanceNetType | string | yes | The network connectivity type of the instance. Set the value to Intranet, which indicates an internal network connection |
| DBInstanceDescription | string | no | The description of the instance. The description must be 2 to 255 characters in length. It must start with a letter and can contain… |
| SecurityIPList | string | yes | The https://help.aliyun.com/document_detail/43185.html of the instance. Separate multiple IP addresses or CIDR blocks with commas (,).… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to… |
| PayType | string | yes | The billing method of the instance. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription. Serverless: serverless billing method.… |
| ZoneId | string | no | The zone ID of the primary node. If you specify a VPC and a vSwitch, you must specify the zone ID of the target vSwitch. Otherwise, the… |
| ZoneIdSlave1 | string | no | The zone ID of the secondary node. If you set this parameter to Auto, the instance uses a multi-zone deployment, and the system… |
| ZoneIdSlave2 | string | no | The zone ID of the second secondary node. ApsaraDB RDS for MySQL Cluster Edition instances support the creation of one or two secondary… |
| InstanceNetworkType | string | no | The network type of the instance. Valid values: VPC: VPC. Classic: classic network. ApsaraDB RDS for MySQL cloud disk instances support… |
| ConnectionMode | string | no | The access mode of the instance. Valid values: Standard: standard access mode. Safe: database proxy mode. The default value is allocated… |
| VPCId | string | no | The VPC ID. This parameter takes effect only when the network type InstanceNetworkType is set to VPC |
| VSwitchId | string | no | The vSwitch ID. Zone mapping: The zone of the vSwitch specified by VSwitchId must correspond to the zone of the primary node (ZoneId) and… |
| PrivateIpAddress | string | no | The internal IP address of the instance. The IP address must be within the address range of the specified vSwitch. By default, the system… |
| UsedTime | string | no | The subscription duration. Valid values: If Period is set to Year, the valid values of UsedTime are 1 to 5. If Period is set to Month, the… |
| Period | string | no | The subscription period of the subscription instance. Valid values: Year: yearly subscription. Month: monthly subscription. This parameter… |
| ResourceGroupId | string | no | The resource group ID |
| DBInstanceStorageType | string | no | The instance storage type. Valid values: local_ssd: premium local SSD (recommended). general_essd: premium cloud disk (recommended).… |
| BusinessInfo | string | no | The extended business parameters |
| EncryptionKey | string | no | The ID of the key used for cloud disk encryption in the same region. If you specify this parameter, cloud disk encryption is enabled and… |
| RoleARN | string | no | The global resource descriptor (ARN) used for the authorization of the ApsaraDB RDS service account to access KMS. You can invoke the… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal for the instance. This parameter is valid only when you create a subscription instance. Valid… |
| Category | string | no | The instance edition. Valid values: Regular instances * Basic: Basic Edition. * HighAvailability: high-availability series. * cluster:… |
| DedicatedHostGroupId | string | no | The ID of the dedicated cluster host group. This parameter is required when you create an instance in a dedicated cluster. You can call… |
| TargetDedicatedHostIdForMaster | string | no | The ID of the host on which the primary instance is created in the dedicated cluster. This parameter is required when you create an… |
| TargetDedicatedHostIdForSlave | string | no | The ID of the host on which the secondary instance is created in the dedicated cluster. This parameter is required when you create a… |
| TargetDedicatedHostIdForLog | string | no | The ID of the host on which the logger instance is created in the dedicated cluster. This parameter is required when you create an RDS… |
| DBParamGroupId | string | no | The ID of the parameter template. You can call the DescribeParameterGroups operation to query the parameter template ID. This parameter is… |
| DBTimeZone | string | no | The time zone of the instance. This parameter takes effect only when Engine is set to MySQL or PostgreSQL. If Engine is set to MySQL: -… |
| DBIsIgnoreCase | string | no | Specifies whether table names are case-sensitive. Valid values: true: Table names are not case-sensitive. This is the default value.… |
| TargetMinorVersion | string | no | The minor engine version of the ApsaraDB RDS instance. This parameter is required only when you create a MySQL or PostgreSQL instance.… |
| StorageAutoScale | string | no | Specifies whether to enable automatic storage expansion. This parameter is supported only by MySQL and PostgreSQL. Valid values: Enable:… |
| StorageThreshold | integer | no | The threshold percentage that triggers automatic storage expansion. Valid values: 10 20 30 40 50 This parameter is required when… |
| StorageUpperBound | integer | no | The upper limit of the total storage capacity for automatic storage expansion. The automatic expansion does not cause the total storage… |
| DryRun | string | no | Specifies whether to perform a precheck for the instance creation operation. Valid values: true: performs a precheck but does not create… |
| UserBackupId | string | no | The ID of the user backup. You can call the ListUserBackupFiles operation to query the backup ID. If you specify this parameter, the… |
| Amount | integer | no | The number of ApsaraDB RDS for MySQL instances to create. This parameter is applicable only when you create multiple ApsaraDB RDS for… |
| CreateStrategy | string | no | The strategy for creating multiple instances at a time. This parameter takes effect only when Amount is greater than 1. Valid values:… |
| Tag | string | no | The tags (JSON-encoded) |
| DeletionProtection | string | no | Specifies whether to enable the release protection feature for the ApsaraDB RDS instance. This feature is supported only for pay-as-you-go… |
| BabelfishConfig | string | no | The configuration information of Babelfish for ApsaraDB RDS for PostgreSQL. Configuration format:… |
| ServerlessConfig | string | no | The settings for the ApsaraDB RDS Serverless instance. This parameter is required when you create a Serverless instance. MariaDB does not… |
| ConnectionString | string | no | The internal endpoint of the database. Endpoint format: `xxx.mysql.rds.aliyuncs.com`, where `xxx` is the prefix of the instance ID, such… |
| Port | string | no | The port used to initialize the instance during creation. Valid values: MySQL: 1000 to 65534 PostgreSQL, SQL Server, and MariaDB: 1000 to… |
| BpeEnabled | string | no | The BpeEnabled |
| BurstingEnabled | string | no | Specifies whether to enable the I/O performance burst feature for premium cloud disks. Valid values: true: enables the feature. false:… |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. You must ensure that your account balance is… |
| IoAccelerationEnabled | string | no | Specifies whether to enable the https://help.aliyun.com/document_detail/2527067.html feature for premium cloud disks. Valid values: 1:… |
| ColdDataEnabled | string | no | Specifies whether to enable the https://help.aliyun.com/document_detail/2701832.html feature for premium cloud disks. Valid values: true:… |
| WhitelistTemplateList | string | no | The whitelist templates. When you need to configure multiple IP addresses, separate multiple IP addresses or CIDR blocks with commas (,).… |
| AutoCreateProxy | string | no | Specifies whether to automatically create a proxy. Valid values: true: enables automatic creation. By default, a general-purpose proxy is… |
| AutoUseCoupon | string | no | Specifies whether to use vouchers. Valid values: true: uses vouchers. false: does not use vouchers. This is the default value. If you use… |
| PromotionCode | string | no | The coupon code |
| OptimizedWrites | string | no | Specifies whether to enable the https://help.aliyun.com/document_detail/2858761.html feature. Valid values: optimized: enables the… |
| ExternalReplication | string | no | Specifies whether to enable https://help.aliyun.com/document_detail/2856526.html. Valid values: ON: enables the feature. OFF: disables the… |
| CustomExtraInfo | string | no | The CustomExtraInfo |
| AutoUpgradeMinorVersion | string | no | Specifies whether to enable or disable automatic minor version upgrades. Valid values: Auto: Enabled. Manual: Disabled |

### Creates an endpoint for an ApsaraDB RDS Cluster Edition instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-dbinstance-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to… |
| DBInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID |
| VpcId | string | yes | The ID of the VPC for the internal network connection |
| VSwitchId | string | yes | The ID of the vSwitch for the internal network connection |
| PrivateIpAddress | string | no | The IP address for the internal network connection |
| ConnectionStringPrefix | string | yes | The prefix of the internal endpoint. When you create an endpoint, an internal endpoint is automatically created. This parameter specifies… |
| Port | string | yes | The port number for the internal network connection. You can specify a custom port number when you create an internal network connection.… |
| DBInstanceEndpointType | string | yes | The endpoint type. Valid values: Primary: the read/write endpoint of the instance. Readonly: the read-only endpoint of the instance |
| DBInstanceEndpointDescription | string | no | The custom description of the endpoint |
| NodeItems | string | yes | The list of nodes associated with the endpoint (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID |

### Creates a public endpoint for an endpoint of an ApsaraDB RDS Cluster Edition instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-dbinstance-endpoint-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. The value is generated by the… |
| DBInstanceId | string | yes | Instance ID of the instance. You can call the DescribeDBInstances operation to query instance ID |
| DBInstanceEndpointId | string | yes | The ID of the endpoint. You can call the DescribeDBInstanceEndpoints operation to query the ID |
| ConnectionStringPrefix | string | yes | The prefix of the public endpoint |
| Port | string | yes | The port number of the public endpoint |
| IpType | string | yes | The network type of the endpoint. Only the public network type is supported. Set the value to Public |
| ResourceGroupId | string | no | The ID of the resource group. You can call the DescribeDBInstanceAttribute operation to obtain the ID |

### Rebuilds an instance that has been moved to the recycle bin
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-dbinstance-for-rebuild` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID |
| DBInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID |
| PayType | string | yes | The billing method of the destination instance. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription |
| SecurityIPList | string | no | The https://help.aliyun.com/document_detail/43185.html of the instance. Separate multiple entries with commas (,). Duplicate entries are… |
| DBInstanceDescription | string | no | The name of the destination instance. The name must be 2 to 256 characters in length. It must start with a Chinese or English letter and… |
| ZoneId | string | no | The zone ID of the primary node. You can call the DescribeRegions operation to query the zone ID. If you specify a VPC and a vSwitch, you… |
| ZoneIdSlave1 | string | no | The secondary zone 1. You must specify this parameter for instances that are not of the Basic Edition |
| ZoneIdSlave2 | string | no | The secondary zone 2. You can specify this parameter only for instances of the Enterprise Edition |
| VPCId | string | no | The VPC ID of the destination instance. You must specify this parameter when InstanceNetworkType is set to VPC. If you specify this… |
| VSwitchId | string | no | The vSwitch ID. The zone where the vSwitch is located must match the zone ID specified by the ZoneId parameter. The InstanceNetworkType… |
| Period | string | no | The subscription period of the subscription instance. Valid values: Year: yearly subscription. Month: monthly subscription. You must… |
| UsedTime | string | no | The subscription duration. Valid values: If the Period parameter is set to Year, the value of the UsedTime parameter ranges from 1 to 5.… |
| 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 make… |
| DBInstanceNetType | string | no | The network connectivity type of the instance. Valid values: Internet: public network connection. Intranet: internal network connection |
| InstanceNetworkType | string | no | The network type of the destination instance. Valid values: VPC: VPC. Classic: classic network. By default, an instance in the classic… |
| ResourceGroupId | string | no | The resource group ID. This parameter can be left empty |

### Creates a replication task for a native replication instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-dbinstance-replication` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DbInstanceId | string | yes | Instance ID of the instance. You can call the DescribeDBInstances operation to query instance ID |
| ChannelName | string | no | The name of the replication channel, which is used to identify the replication task |
| MasterHost | string | yes | The host address of the primary database. Both IP addresses and domain names are supported |
| MasterPort | integer | yes | The port number of the primary database. Typically, the port is 3306 for MySQL |
| MasterUser | string | yes | The username of the primary database used to establish a replication connection |
| MasterPassword | string | yes | The password of the primary database used to authenticate the replication user. The password must be Base64-encoded in advance |

### Adds a security group rule to an ApsaraDB RDS for SQL Server instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-dbinstance-security-group-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | Instance ID of the instance. You can call the https://help.aliyun.com/document_detail/2628785.html operation to query instance ID |
| PortRange | string | yes | The range of destination ports for the transport layer protocol (TCP or UDP) specified in the security group rule. Valid values: 1 to… |
| IpProtocol | string | no | The transport-layer protocol type. Valid values: TCP UDP |
| SourceCidrIp | string | no | The source IP address range. IP address ranges in CIDR format and IPv4 format are supported |
| Description | string | no | The description of the security group rule |

### Adds a node to an ApsaraDB RDS Cluster Edition instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-dbnodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to… |
| DBInstanceId | string | yes | Instance ID of the instance. You can call the DescribeDBInstances operation to query instance ID |
| DBNode | string | yes | The list of cluster nodes (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group. You can call the DescribeDBInstanceAttribute operation to query the ID |

### Creates a database proxy endpoint for an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-dbproxy-endpoint-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the DescribeRegions operation to query the region ID |
| DBInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID |
| DBProxyEndpointId | string | yes | The ID of the database proxy endpoint. You can call the DescribeDBProxyEndpoint operation to query the database proxy endpoint ID |
| ConnectionStringPrefix | string | yes | The prefix of the new database proxy endpoint. You can customize the prefix |
| DBProxyNewConnectStringPort | string | no | The port of the new database proxy endpoint. Default values: MySQL: 3306 PostgreSQL: 5432 |
| DBProxyConnectStringNetType | string | yes | The network type of the new database proxy endpoint. Valid values: Public: Internet VPC (default): VPC |
| VPCId | string | no | The VPC ID of the new database proxy endpoint. You can call the DescribeDBInstanceAttribute operation to query the VPC ID. This parameter… |
| VSwitchId | string | no | The vSwitch ID of the new database proxy endpoint. You can call the DescribeDBInstanceAttribute operation to query the vSwitch ID. This… |
| DBProxyEngineType | string | no | The reserved parameter. You do not need to specify this parameter |
| ResourceGroupId | string | no | The resource group ID |

### Creates a database in an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to query the instance ID |
| DBName | string | yes | The database name. The name must be 2 to 64 characters in length. The name must start with a letter and end with a letter or digit. The… |
| CharacterSetName | string | yes | The character set. Valid values: MySQL/MariaDB: utf8, gbk, latin1, utf8mb4 SQL Server: Chinese_PRC_CI_AS, Chinese_PRC_CS_AS,… |
| CollationName | string | no | The collation. This parameter is supported only for ApsaraDB RDS for MySQL instances. Specify a collation that matches the character set.… |
| DBDescription | string | no | The database description. The description must be 2 to 256 characters in length and can contain letters, digits, Chinese characters,… |
| AccountName | string | no | The AccountName |
| AccountPrivilege | string | no | The AccountPrivilege |

### Restores data across regions to a new instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-ddr-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the destination region. You can call the DescribeRegions operation to query region IDs |
| Engine | string | yes | The type of the destination database engine. Valid values: MySQL SQLServer PostgreSQL |
| EngineVersion | string | yes | The version of the destination database engine. Valid values vary based on the Engine parameter: MySQL: 5.5/5.6/5.7/8.0 SQL Server: 2008r2… |
| DBInstanceClass | string | no | The instance type of the destination instance. For more information, see https://help.aliyun.com/document_detail/26312.html |
| DBInstanceStorage | integer | no | The storage capacity of the destination instance. Valid values: 5 to 2000. The increment is 5 GB. Unit: GB. For more information, see… |
| SystemDBCharset | string | no | The character set of the destination instance. Valid values: utf8 gbk latin1 utf8mb4 |
| DBInstanceNetType | string | yes | The network connection type of the destination instance. Valid values: Internet: public network connection Intranet: internal network… |
| DBInstanceDescription | string | no | The name of the destination instance. The name must be 2 to 256 characters in length. It must start with a letter or a Chinese character… |
| SecurityIPList | string | yes | The https://help.aliyun.com/document_detail/43185.html of the destination instance. Separate multiple IP addresses with commas (,). You… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to… |
| PayType | string | yes | The billing method of the destination instance. Valid values: Postpaid: pay-as-you-go Prepaid: subscription |
| ZoneId | string | no | The zone ID of the destination instance. Separate multiple zone IDs with colons (:). If you specify a VPC and a vSwitch, this parameter is… |
| InstanceNetworkType | string | no | The network type of the destination instance. Valid values: VPC: VPC Classic: classic network (discontinued) If you select VPC, you must… |
| ConnectionMode | string | no | The access mode of the destination instance. Valid values: Standard (default): standard access mode Safe: database proxy mode |
| VPCId | string | no | The VPC ID of the destination instance. This parameter is required when InstanceNetworkType is set to VPC. After you specify this… |
| VSwitchId | string | no | The vSwitch ID of the destination instance. Separate multiple vSwitch IDs with commas (,). This parameter is required when… |
| PrivateIpAddress | string | no | The internal IP address of the destination instance. The IP address must be within the CIDR block of the specified vSwitch. By default,… |
| UsedTime | string | no | The subscription duration. Valid values: If the Period parameter is set to Year, valid values are 1 to 3. If the Period parameter is set… |
| Period | string | no | Specifies the subscription period of the destination instance as yearly or monthly. Valid values: Year: yearly Month: monthly This… |
| ResourceGroupId | string | no | The ID of the resource group |
| RestoreType | string | yes | The restoration method. Valid values: BackupSet: restores data from a backup set to the new instance. You must also specify the… |
| BackupSetId | string | no | The ID of the backup set used for restoration. You can call the DescribeCrossRegionBackups operation to query backup set IDs. This… |
| BackupSetRegion | string | no | The region where the backup set resides |
| RestoreTime | string | no | The point in time to which you want to restore data. The time must be earlier than the current time. Specify the time in the yyyy-MM-dd T… |
| SourceRegion | string | no | The ID of the source region for point-in-time restoration. This parameter is required when RestoreType is set to BackupTime |
| SourceDBInstanceName | string | no | The ID of the source instance for point-in-time restoration. This parameter is required when RestoreType is set to BackupTime |
| DBInstanceStorageType | string | no | The storage type of the destination instance. Valid values: We recommend that you keep the storage type consistent with that of the source… |
| RoleARN | string | no | The Alibaba Cloud Resource Name (ARN) used for the authorization of the Alibaba Cloud account to grant the ApsaraDB RDS service account… |
| EncryptionKey | string | no | The ID of the custom key used for cloud disk encryption of the SQL Server instance. If you specify this parameter, cloud disk encryption… |

### Creates an ApsaraDB RDS global active database cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-gadinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| CentralRegionId | string | yes | The region ID of the central node. You can call the DescribeRegions operation to query the region ID |
| CentralDBInstanceId | string | yes | The ID of the primary instance. You can call the DescribeDBInstances operation to query the ID. This instance serves as the central node… |
| DBList | string | yes | The JSON array of database information in the central node. All database information in the array is used for synchronization to the… |
| Description | string | no | The name of the ApsaraDB RDS global active database cluster |
| UnitNode | string | yes | The information about the unit node (JSON-encoded) |
| CentralRdsDtsAdminAccount | string | yes | The privileged account of the central node. You can call the DescribeAccounts operation to query the account |
| CentralRdsDtsAdminPassword | string | yes | The password of the privileged account for the central node |
| Tag | string | no | The list of tags (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |

### Adds a node to an ApsaraDB RDS global active database cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-gad-instance-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| CentralRegionId | string | yes | The region ID of the central node (primary node). You can call the DescribeRegions operation to query the region ID |
| CentralDBInstanceId | string | yes | The ID of the central node. You can call the DescribeGadInstances operation to query the ID |
| GadInstanceId | string | yes | The ID of the ApsaraDB RDS global active database cluster. You can call the DescribeGadInstances operation to query the ID |
| UnitNode | string | yes | The list of unit node (secondary node) information (JSON-encoded) |
| CentralRdsDtsAdminAccount | string | yes | The privileged account of the central node. You can call the DescribeAccounts operation to query the account |
| CentralRdsDtsAdminPassword | string | yes | The password of the privileged account of the central node |
| DBList | string | yes | The JSON array of database information in the central node. All database information in the array is synchronized to the current unit… |

### Creates a data import task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-import-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/610399.html operation to query the region ID |
| Host | string | yes | The IP address of the source MySQL host. ApsaraDB RDS accesses this IP address to retrieve backups |
| Port | integer | yes | The port of the source MySQL database |
| StreamPort | integer | yes | The streaming port used to transfer backups |
| User | string | yes | The source MySQL account. The account must have the permissions to create backups and configure replication. Refer to the following SQL… |
| Password | string | yes | The password of the source MySQL account. The password must be Base64-encoded |
| SourcePlatform | string | no | The type of the source cloud instance |
| SourceInstanceId | string | no | The instance ID of the source cloud instance |
| XtrabackupPath | string | no | The installation path of XtraBackup on the source instance |
| DbInstanceId | string | yes | The instance ID |
| EstimatedSize | integer | no | The estimated data size. Unit: GB |

### Creates a new encryption or masking rule for a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-masking-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RuleName | string | yes | The name of the rule. Only one rule name can be specified at a time |
| MaskingAlgo | string | no | The rule algorithm. You can specify multiple algorithms. Additional parameters can be added for masking algorithms. Format: {name:… |
| DefaultAlgo | string | no | The name of the default encryption or masking algorithm |
| RuleConfig | string | no | The rule configuration. The value is a JSON string that contains the matching rules for databases, tables, and columns (JSON-encoded) |
| DBInstanceName | string | yes | The instance ID |
| RegionId | string | no | The region ID |
| DBName | string | no | The name of the database |

### Restores self-managed SQL Server backup files from Object Storage Service (OSS) to an ApsaraDB RDS for SQL…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-migrate-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to query the ID |
| DBName | string | yes | The name of the destination database |
| BackupMode | string | yes | The type of the cloud migration task. Valid values: FULL: restores data by using a full backup file. This value is applicable to the first… |
| IsOnlineDB | string | yes | Specifies whether to bring the restored database online for user access. Valid values: True: brings the database online. False: does not… |
| CheckDBMode | string | no | The consistency check method used after the database is opened. This parameter takes effect only when IsOnlineDB is set to True. Valid… |
| OssObjectPositions | string | no | The components of the OSS file. The value consists of the following three parts separated by colons (:): OSS endpoint:… |
| OSSUrls | string | no | The shared URL of the backup file in OSS. The URL must be encoded. If multiple URLs exist, separate them with vertical bars (/) and then… |
| MigrateTaskId | string | no | The ID of the migration task. Valid values: If BackupMode is set to FULL, leave this parameter empty. This ensures compatibility with SQL… |
| KeepCDC | string | no | Specifies whether to retain the database- and table-level Change Data Capture (CDC) switches and change table data. This parameter takes… |

### Opens the database for a backup data migration task in ApsaraDB RDS for SQL Server
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-online-database-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of… |
| DBInstanceId | string | yes | Instance ID of the instance. You can call the DescribeDBInstances operation to query instance ID |
| DBName | string | yes | The name of the database |
| MigrateTaskId | string | yes | The ID of the migration task |
| CheckDBMode | string | yes | The consistency check method used after the database is opened. Valid values: SyncExecuteDBCheck: Executes the database check… |
| KeepCDC | string | no | Specifies whether to retain the database-level and table-level Change Data Capture (CDC) settings and the data in change tables.… |

### Deletes nodes from an ApsaraDB RDS for MySQL Cluster Edition instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-order-for-delete-dbnodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to… |
| CommodityCode | string | yes | The commodity code. Valid values: bards: pay-as-you-go primary instance rds: subscription primary instance rords: pay-as-you-go read-only… |
| DBInstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/610396.html operation to query the instance ID |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/610399.html operation to query the region ID |
| ZoneId | string | no | The zone ID |
| Resource | string | no | The resource |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. You must ensure that your account balance is… |
| PromotionCode | string | no | The coupon code |
| EngineVersion | string | no | The current database engine version. Valid values: MySQL: 5.5, 5.6, 5.7, and 8.0 |
| NodeType | string | no | The database node type. Valid values: Master: primary node Slave: secondary node |
| BusinessInfo | string | no | The business extension parameters |
| DBNodeId | string | no | The list of node IDs (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |

### Creates a parameter template for ApsaraDB RDS
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the parameter template. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the most recent region… |
| ParameterGroupName | string | yes | The name of the parameter template. The name must start with a letter and can contain letters, digits, periods (.), and underscores (_).… |
| Engine | string | yes | The database engine. Valid values: mysql PostgreSQL |
| EngineVersion | string | yes | The database engine version. Valid values: MySQL: * 5.6 * 5.7 * 8.0 PostgreSQL: * 10.0 * 11.0 * 12.0 * 13.0 * 14.0 * 15.0 |
| Parameters | string | yes | A JSON string that consists of parameters and their values. Format: {"Parameter 1":"Value of Parameter 1","Parameter 2":"Value of… |
| ParameterGroupDesc | string | no | The description of the parameter template. The description can be up to 200 characters in length |
| ResourceGroupId | string | no | The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID |

### Installs a specified plug-in in a destination database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-postgres-extensions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate requests. You can use the client to generate… |
| DBInstanceId | string | yes | Instance ID of the instance. You can call the DescribeDBInstances operation to obtain instance ID |
| Extensions | string | no | The plug-ins to be installed. Separate multiple plug-ins with commas (,). If you do not specify the SourceDatabase request parameter, you… |
| DBNames | string | yes | The name of the database on the instance. You can call the DescribeDatabases operation to obtain the name |
| AccountName | string | yes | The user to which the plug-in belongs. Only privileged accounts are supported |
| SourceDatabase | string | no | The source database from which plug-ins are synchronized to the destination database. If you do not specify the Extensions request… |
| ResourceGroupId | string | no | The ID of the resource group |
| RiskConfirmed | string | no | Specifies whether security risk of installing specific plug-ins on instances with outdated minor engine versions is confirmed. You can… |

### Creates an RDS Custom data cloud disk
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-rcdisk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query region IDs |
| SnapshotId | string | no | The ID of the snapshot used to create the cloud disk. You can use RDS Custom snapshots and ECS snapshots (excluding shared snapshots). If… |
| Size | integer | no | The size of the cloud disk. Unit: GiB. You must specify this parameter. Valid values: cloud_efficiency: 20 to 32,768. cloud_ssd: 20 to… |
| DiskCategory | string | no | The category of the data cloud disk. Valid values: cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: ESSD. cloud_auto… |
| Description | string | no | The description of the cloud disk. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://` |
| PerformanceLevel | string | no | The performance level of the ESSD cloud disk. Valid values: PL0: A single ESSD can deliver up to 10,000 random read/write IOPS. PL1… |
| ZoneId | string | no | The zone ID. This parameter is required when you do not specify the InstanceId parameter, which is the instance ID of the instance to… |
| InstanceChargeType | string | no | The billing method. Valid values: Postpaid: pay-as-you-go. Cloud disks of this billing method do not need to be mounted to instances. You… |
| PeriodUnit | string | no | A reserved parameter. You do not need to specify this parameter |
| Period | integer | no | A reserved parameter. You do not need to specify this parameter |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. This parameter is valid only when you create a subscription data cloud disk. Valid values: true:… |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true (default): Automatic payment is enabled. Make sure that your account… |
| DiskName | string | no | The name of the cloud disk. The name must be 2 to 128 characters in length and can contain letters and digits in the Unicode Letter… |
| InstanceId | string | no | Instance ID of the instance to which the cloud disk is attached. If InstanceChargeType is set to Prepaid, you must specify instance ID of… |
| Tag | string | no | The list of tags (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group |

### Creates a custom image for an RDS Custom instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-rcimage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the DescribeRegions operation to query the region ID |
| SnapshotId | string | no | The ID of the snapshot used to create the custom image. You can call the DescribeRCSnapshots operation to query the snapshot ID |
| ImageName | string | no | The name of the custom image |
| InstanceId | string | no | The RDS Custom instance ID |

### Creates an edge node pool in an ACK Edge cluster for RDS Custom
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-rcnode-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| InstanceType | string | yes | The instance type. For the instance types supported by RDS Custom, see https://help.aliyun.com/document_detail/2844823.html |
| Amount | integer | no | Specifies the number of RDS Custom instances to create. This parameter is applicable only when you create multiple RDS Custom instances at… |
| Period | integer | no | The subscription duration of the resource. Default value: 1 |
| PeriodUnit | string | no | The time unit of the subscription billing method. Valid values: Year: year. Month (default): month |
| AutoRenew | string | no | Specifies whether to enable auto-renewal for the instance. This parameter is valid only when you create a subscription instance. Valid… |
| SecurityEnhancementStrategy | string | no | Reserved parameter. Not supported |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to… |
| Password | string | no | The password of the root account for the instance |
| VSwitchId | string | yes | The vSwitch ID. The vSwitch must be in the same zone as the RDS instance |
| DataDisk | string | no | The data cloud disks (JSON-encoded) |
| InstanceName | string | no | The instance name |
| DeploymentSetId | string | no | The deployment set ID |
| InternetChargeType | string | no | Reserved parameter. Not supported |
| InternetMaxBandwidthOut | integer | no | Reserved parameter. Not supported |
| SecurityGroupId | string | no | The security group ID. You can specify an existing security group ID. If the specified security group does not exist, a security group is… |
| ZoneId | string | no | The zone ID of the instance. If you specify the VSwitchId parameter, the ZoneId parameter must be set to the zone where the vSwitch… |
| IoOptimized | string | no | Reserved parameter. Not supported |
| ImageId | string | no | The image ID of the instance |
| SystemDisk | string | no | The system cloud disk (JSON-encoded) |
| InstanceChargeType | string | no | The billing method. Valid values: Prepaid: subscription. Postpaid: pay-as-you-go |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: Automatic payment is enabled. Make sure that your account balance is… |
| Description | string | no | The instance description. The description must be 2 to 256 characters in length and cannot start with http:// or https:// |
| KeyPairName | string | no | The key pair name. Only one key pair name is supported |
| DryRun | string | no | Specifies whether to perform a dry run before creating the instance. Valid values: true: A dry run is performed and no instance is… |
| Tag | string | no | The tags (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |
| CreateMode | string | no | Specifies whether the instance is allowed to join an ACK cluster. When this parameter is set to 1, the created instance can be added to an… |
| HostName | string | no | The hostname of the instance |
| SpotStrategy | string | no | Reserved parameter. Not supported |
| ClusterId | string | yes | The RDS Custom container cluster ID |
| NodePoolName | string | no | The node pool name |
| SupportCase | string | no | The supported scenario. This parameter is required when the createMode parameter is set to 1. Only edge is supported |
| UserData | string | no | Reserved parameter. Not supported |

### Creates a snapshot for a cloud disk
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-rcsnapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| DiskId | string | no | The cloud disk ID |
| Description | string | no | The description of the snapshot. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.… |
| ZoneId | string | no | This parameter is deprecated. You do not need to specify it |
| InstantAccess | string | no | This parameter is deprecated. You do not need to specify it |
| InstantAccessRetentionDays | integer | no | This parameter is deprecated. You do not need to specify it |
| RetentionDays | integer | no | Settings for the retention period of the snapshot. Unit: days. After the retention period expires, the snapshot is subject to automatic… |
| Tag | string | no | The tag details (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |

### Creates a read-only instance for an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-read-only-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| 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 make… |
| RegionId | string | yes | The region ID. The read-only instance must reside in the same region as the primary instance. You can call… |
| ZoneId | string | yes | The zone ID. You can call https://help.aliyun.com/document_detail/26243.html to query the most recent zone list. For single-zone… |
| DBInstanceId | string | yes | The primary instance ID. You can call https://help.aliyun.com/document_detail/26232.html to query the instance ID |
| DBInstanceClass | string | yes | The instance type. For more information, see https://help.aliyun.com/document_detail/145759.html. We recommend that the specifications of… |
| DBInstanceStorage | integer | yes | Instance storage capacity. Instance storage capacity of the read-only instance must be greater than or equal to that of the primary… |
| EngineVersion | string | yes | The database engine version. The version must be the same as that of the primary instance. Valid values for MySQL: 5.6, 5.7, and 8.0.… |
| PayType | string | yes | The billing method. Valid values: Postpaid: pay-as-you-go Prepaid: subscription |
| DBInstanceDescription | string | no | The instance description. The description must be 2 to 256 characters in length and can contain letters, digits, underscores (_), and… |
| InstanceNetworkType | string | no | The network type of the read-only instance. Valid values: VPC: virtual private cloud (VPC) Classic: classic network By default, a… |
| VPCId | string | no | The VPC ID of the read-only instance. This parameter is required when InstanceNetworkType is left empty or set to VPC. If the storage type… |
| VSwitchId | string | no | The vSwitch ID of the read-only instance. This parameter is required when InstanceNetworkType is left empty or set to VPC |
| PrivateIpAddress | string | no | The internal IP address of the read-only instance. The IP address must be within the address range of the specified vSwitch. The system… |
| ResourceGroupId | string | no | The resource group ID |
| Category | string | no | The instance edition. Valid values: Basic: Basic Edition HighAvailability: High-availability Edition (default) AlwaysOn: Cluster Edition *… |
| DBInstanceStorageType | string | no | The storage type of the instance. Valid values: local_ssd: Premium Local SSDs cloud_ssd: standard SSDs cloud_essd: PL1 ESSDs cloud_essd2:… |
| DedicatedHostGroupId | string | no | The dedicated cluster ID. This parameter is required when you create a read-only instance in a dedicated cluster |
| TargetDedicatedHostIdForMaster | string | no | The host ID of the primary instance in the dedicated cluster. This parameter is required when you create a read-only instance in a… |
| GdnInstanceName | string | no | A reserved parameter. You do not need to specify this parameter |
| TddlBizType | string | no | A reserved parameter. You do not need to specify this parameter |
| TddlRegionConfig | string | no | A reserved parameter. You do not need to specify this parameter |
| InstructionSetArch | string | no | A reserved parameter. You do not need to specify this parameter |
| UsedTime | string | no | The subscription duration. Valid values: If Period is set to Year, the valid values of UsedTime are 1 to 5. If Period is set to Month, the… |
| Period | string | no | The subscription type of the instance. Valid values: Year: yearly subscription Month: monthly subscription |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. This parameter is required only for subscription instances. Valid values: true: enables… |
| DeletionProtection | string | no | Specifies whether to enable the release protection feature for the instance. Valid values: true: enables release protection. false:… |
| Port | string | no | The port that is initialized when you create a read-only instance for an ApsaraDB RDS for MySQL primary instance. Valid values: 1000 to… |
| BpeEnabled | string | no | The BpeEnabled |
| BurstingEnabled | string | no | Specifies whether to enable the I/O performance burst feature for https://help.aliyun.com/document_detail/2340501.html. Valid values:… |
| IsAnalyticReadOnlyIns | string | no | Specifies whether to create a DuckDB-based analytical instance. Valid values: true: creates a DuckDB-based analytical instance. false:… |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. Make sure that your account balance is… |
| AutoCreateProxy | string | no | Specifies whether to automatically create a database proxy. Valid values: true: enables automatic creation. By default, a general-purpose… |
| IoAccelerationEnabled | string | no | Specifies whether to enable the https://help.aliyun.com/document_detail/2527067.html feature for Premium ESSDs. Valid values: 1: enables… |
| AutoUseCoupon | string | no | Specifies whether to use coupons. Valid values: true: uses coupons. false (default): does not use coupons |
| PromotionCode | string | no | The coupon code |
| CustomExtraInfo | string | no | A reserved parameter. You do not need to specify this parameter |

### Creates a data synchronization link for an RDS disaster recovery instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-replication-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID of the disaster recovery instance |
| DryRun | string | yes | Specifies whether to perform a dry run for creating the synchronization link of the disaster recovery instance. Valid values: true:… |
| SourceAddress | string | no | The endpoint of the PostgreSQL source instance or the IP address of the SQL Server source instance |
| SourcePort | integer | no | The port of the source instance |
| ReplicatorAccount | string | no | The database account used for data synchronization |
| ReplicatorPassword | string | no | The password of the synchronization account |
| TaskId | integer | no | The ID of a successful dry run task |
| SourceCategory | string | no | The category of the source instance. Valid values: other: Other. (Not supported for SQL Server.) aliyunRDS: ApsaraDB RDS instance |
| SourceInstanceRegionId | string | no | The region ID of the source instance. This parameter is required when SourceCategory is set to aliyunRDS |
| SourceInstanceName | string | no | The name of the source instance. This parameter is required when SourceCategory is set to aliyunRDS |
| TaskName | string | no | The name of the dry run task. You can specify a custom name. If you do not specify this parameter, the system automatically generates a name |
| TargetAddress | string | no | The IP address of the SQL Server disaster recovery instance |

### Creates a Data API user credential
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. The value is generated by the… |
| RegionId | string | yes | The region ID. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance |
| Username | string | yes | The database username |
| Password | string | yes | The database password |
| DbInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to query the value of this parameter |
| ResourceGroupId | string | yes | The ID of the resource group to which the instance belongs. You can call the DescribeDBInstanceAttribute operation to query the value of… |
| DbNames | string | no | The database names |
| Description | string | no | The description of the credential |
| SecretName | string | no | The name of the credential |
| Engine | string | yes | The database engine type. Currently, only MySQL is supported |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call DescribeRegions to query the available regions |
| ServiceLinkedRole | string | yes | The service-linked role. Valid values: AliyunServiceRoleForRds: the service-linked role associate with ApsaraDB RDS for MySQL.… |

### Creates a temporary instance for an ApsaraDB RDS for SQL Server 2008 R2 instance with Premium Local SSDs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-temp-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| BackupId | integer | no | The backup set ID. You can call the DescribeBackups operation to query the backup set ID. You must specify at least one of BackupId and… |
| RestoreTime | string | no | A point in time within the backup retention period. Format: yyyy-MM-dd T HH:mm:ss Z (UTC). You can specify any point in time within the… |
| ResourceGroupId | string | no | The resource group ID |

### Redeems a coupon
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/create-youhui-for-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ActivityId | integer | yes | The ID of the created ticket |
| PromotionId | integer | yes | The promotion ID. You can call the GetResourcePrice operation to obtain the promotion ID |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query region IDs |

### Removes the current ApsaraDB RDS for SQL Server instance from its domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-adsetting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of… |
| DBInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID |
| RegionId | string | yes | The region ID |

### Deletes a database account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to obtain the instance ID |
| AccountName | string | yes | The name of the database account that you want to delete |

### Deletes data backup files of an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to query the instance ID |
| BackupId | string | yes | The backup set ID. You can call DescribeBackups to query the backup set ID. Separate multiple values with commas (,). You can specify up… |

### Deletes backup files of an ApsaraDB RDS for SQL Server instance. This operation is not available to new…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-backup-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call DescribeDBInstanceAttribute to obtain the region ID |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to obtain the instance ID |
| BackupId | string | no | The backup set IDs. Only backup set IDs of individual database backup policies are supported. You can specify up to 100 backup set IDs at… |
| DBName | string | no | The database name |
| BackupTime | string | no | Deletes backup files that were created before the specified point in time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC) |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to query the instance ID |
| ReleasedKeepPolicy | string | no | The data retention policy for archived backups after the instance is released. Valid values: None: No archived backups are retained.… |

### Deletes the endpoint of an ApsaraDB RDS Cluster Edition instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-dbinstance-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to… |
| DBInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID |
| DBInstanceEndpointId | string | yes | The endpoint ID of the instance. You can call the DescribeDBInstanceEndpoints operation to query the endpoint ID |

### Releases the public endpoint of an endpoint for an ApsaraDB RDS Cluster Edition instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-dbinstance-endpoint-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. The value is generated by the… |
| DBInstanceId | string | yes | Instance ID of the instance. You can call the DescribeDBInstances operation to query instance ID |
| DBInstanceEndpointId | string | yes | The ID of the endpoint. You can call the DescribeDBInstanceEndpoints operation to query the ID |
| ConnectionString | string | yes | The public endpoint |

### Deletes the native replication task of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-dbinstance-replication` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to obtain the region ID |
| DbInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to obtain the instance ID |
| ChannelName | string | no | The name of the replication channel, which is used to identify the replication task |

### Deletes security group rules that are configured for an ApsaraDB RDS for SQL Server instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-dbinstance-security-group-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/2628785.html to obtain the instance ID |
| SecurityGroupRuleIds | string | yes | The security group rule ID. You can call https://help.aliyun.com/document_detail/2834044.html to obtain the security group rule 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 token, but you must make… |
| ResourceGroupId | string | no | The resource group ID |

### Deletes nodes from an ApsaraDB RDS Cluster Edition instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-dbnodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. The token is generated by the… |
| DBInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID |
| DBNodeId | string | yes | The node IDs (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID |

### Deletes the database proxy endpoint of an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-dbproxy-endpoint-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the DescribeRegions operation to query the region ID |
| DBInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID |
| DBProxyEndpointId | string | yes | The ID of the database proxy endpoint. You can call the DescribeDBProxyEndpoint operation to query the ID |
| DBProxyConnectStringNetType | string | yes | The network type of the database proxy endpoint that you want to delete. Valid values: Public: public network VPC: internal network (VPC)… |
| DBProxyEngineType | string | no | [Deprecated] This parameter is deprecated. You do not need to configure it |

### Deletes a specified database from an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/610396.html to query the instance ID |
| DBName | string | yes | The database name. You cannot delete multiple databases at a time |

### Deletes an ApsaraDB RDS global active database cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-gad-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| GadInstanceName | string | yes | The ID of the ApsaraDB RDS global active database cluster that you want to delete. You can call DescribeGadInstances to query the cluster ID |
| RegionId | string | no | The region ID of the central node (primary node) in the cluster. You can call DescribeGadInstances to query the region ID |
| ResourceGroupId | string | no | The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID |

### Deletes the encryption or data masking rule for a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-masking-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RuleName | string | yes | The name of the rule to delete |
| DBInstanceName | string | yes | The instance ID |
| RegionId | string | no | The region ID |
| DBName | string | no | The name of the database |

### Deletes an ApsaraDB RDS parameter template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID |
| ParameterGroupId | string | yes | The parameter template ID. You can call the DescribeParameterGroups operation to query the parameter template ID |
| ResourceGroupId | string | no | The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID |

### Deletes the scheduled task for modifying instance parameters
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-parameter-timed-schedule-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | no | The name of the instance |
| TaskId | integer | no | The ID of the scheduled task for parameter modification |

### Deletes a specified extension from the target database of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-postgres-extensions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to… |
| DBInstanceId | string | yes | Instance ID of the instance. You can call the DescribeDBInstances operation to query instance ID |
| Extensions | string | yes | The name of the extension. Separate multiple extensions with commas (,) |
| DBNames | string | yes | The name of the database where the extension resides. Separate multiple databases with commas (,) |
| ResourceGroupId | string | no | The ID of the resource group |

### Deletes RDS Custom nodes from an ACK cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-rccluster-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| VpcId | string | no | The virtual private cloud (VPC) ID. Reserved parameter |
| Nodes | string | no | The node information (JSON-encoded) |
| InstanceIds | string | no | The list of instance IDs (JSON-encoded) |

### Deletes an RDS Custom deployment set
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-rcdeployment-set` (byok)

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

### Releases a pay-as-you-go data cloud disk. Supported disk types include basic cloud disks, ultra cloud disks,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-rcdisk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DiskId | string | yes | The ID of the cloud disk to be released |
| RegionId | string | no | The region ID of the instance |

### Releases one or more subscription RDS Custom instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-rcinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| Force | string | no | Specifies whether to forcibly release running instances. Valid values: Yes: Forcibly releases the instances. No (default): Does not… |
| InstanceId | string | yes | The instance details (JSON-encoded) |
| RegionId | string | no | The region ID of the instance |
| TerminateSubscription | string | no | The reserved parameter |
| DryRun | string | no | Specifies whether to perform a precheck before releasing the instances. Valid values: true: Performs a precheck and does not release the… |

### Deletes a specified cloud disk snapshot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-rcsnapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| SnapshotId | string | yes | The snapshot ID |
| RegionId | string | yes | The region ID |
| Force | string | no | Specifies whether to force delete a snapshot that has been used to create a cloud disk. Valid values: true: Force deletes the snapshot.… |

### Deletes the data synchronization link of a disaster recovery instance and promotes the disaster recovery…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-replication-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID of the disaster recovery instance |
| PromoteToMaster | string | yes | Specifies whether to delete the data synchronization link between the primary instance and the disaster recovery instance, and promote the… |

### Deletes a Data API user credential by calling the DeleteSecret operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| 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 make… |
| RegionId | string | yes | The region ID. You can call the DescribeSecrets operation to query the region ID |
| SecretArn | string | no | The user credential of the Data API account that has been created. You can call the createSecret operation to query the value of this… |
| SecretName | string | no | The name of the user credential. You must specify either SecretArn or this parameter. This parameter must be specified together with… |
| Engine | string | yes | The database engine type. This parameter currently supports only the value MySQL |
| DbInstanceId | string | no | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. This parameter must be specified together with… |
| ResourceGroupId | string | no | The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID |

### Deletes a specified replication slot of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-slot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client and make sure that the… |
| DBInstanceId | string | yes | Instance ID of the target instance. You can call the DescribeDBInstances operation to query instance ID |
| SlotName | string | yes | The name of the replication slot. You can call the DescribeSlots operation to query the name |
| SlotStatus | string | yes | The status of the replication slot. You can call the DescribeSlots operation to query the status. Valid values: ACTIVE: The replication… |
| ResourceGroupId | string | no | The ID of the resource group. This parameter can be left empty |

### Deletes a specified user backup of an ApsaraDB RDS for MySQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/delete-user-backup-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| BackupId | string | yes | The ID of the user backup. You can call the ListUserBackupFiles operation to query the ID |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID |
| ResourceGroupId | string | no | The ID of the resource group. You can call the DescribeDBInstanceAttribute operation to query the resource group ID |

### Queries the instance migration status list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/descibe-imports-from-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| 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 make… |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to query the instance ID |
| Engine | string | yes | The database engine. Set the value to MySQL |
| ImportId | integer | no | The ID of the migration task |
| StartTime | string | yes | The start time of the query. Format: yyyy-MM-dd T HH:mm Z (UTC) |
| EndTime | string | yes | The end time of the query. Format: yyyy-MM-dd T HH:mm Z (UTC) |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The page number. Valid values: any non-zero positive integer that does not exceed the maximum value of the Integer data type. Default… |
| ResourceGroupId | string | no | The resource group ID. You can call DescribeDBInstanceAttribute to query the resource group ID |

### Queries the Active Directory (AD) domain information of the current instance, including the domain join…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-adinfo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of… |
| DBInstanceId | string | yes | Instance ID of the instance. You can call the DescribeDBInstances operation to query instance ID |
| RegionId | string | yes | The region ID |

### Queries the encryption or masking permission configurations for accounts in a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-account-masking-privilege` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The instance ID |
| UserName | string | no | The account name. You can specify a specific account to query |
| RegionId | string | no | The region ID |
| DBName | string | no | The database name |

### Queries the account information of an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to obtain the instance ID. SQL Server 2017 Cluster Edition instances are not supported |
| AccountName | string | no | The name of the database account |
| PageSize | integer | no | The number of entries per page. Valid values: 30 to 200. Default value: 30 |
| PageNumber | integer | no | The page number. Default value: 1. The value must be a positive integer that does not exceed the maximum value of the Integer data type |

### Queries whether the historical events feature is enabled for ApsaraDB RDS
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-action-event-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call DescribeRegions to obtain the region ID |
| ResourceGroupId | string | no | The resource group ID. You can call DescribeDBInstanceAttribute to obtain the resource group ID |

### Retrieves the O&M configuration information of a user, which currently includes the cycle window information…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-active-operation-maintain-conf` (byok)

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

### Queries the details of scheduled O&M tasks for an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| Region | string | no | The region ID of the pending event. You can call the DescribeRegions operation to query the region ID. A value of all specifies all region… |
| TaskType | string | no | The task type. Valid values: rds_apsaradb_ha: primary and secondary node switch. rds_apsaradb_transfer: instance migration.… |
| PageSize | integer | no | The number of entries per page. Default value: 25. Maximum value: 100 |
| PageNumber | integer | no | The page number, which must be greater than 0. Default value: 1 |
| ProductId | string | no | The product name. Valid values: RDS, POLARDB, MongoDB, and Redis. For an ApsaraDB RDS instance, set the value to RDS |
| DbType | string | no | The database engine. Default value: all. Valid values: mysql, pgsql, mssql, and others |
| Status | integer | no | The task status, which is used to filter the returned tasks. Valid values: -1: all tasks. 3: pending tasks. 4: tasks in progress. 5:… |
| InsName | string | no | The instance name. This parameter is optional. If you specify this parameter, you can specify only one instance name |
| AllowChange | integer | no | Specifies whether the execution time can be modified. Default value: -1. Valid values: -1: all tasks. 0: tasks whose execution time cannot… |
| AllowCancel | integer | no | Specifies whether the task can be canceled. Default value: -1. Valid values: -1: all tasks. 0: tasks that cannot be canceled. 1: tasks… |
| ChangeLevel | string | no | The task level. Default value: all. Valid values: all: all tasks. S0: exception recovery tasks. S1: system O&M tasks |

### Queries whitelist templates in batches and supports fuzzy match
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-all-whitelist-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| MaxRecordsPerPage | integer | yes | The number of entries per page. Valid values: 10, 30, and 50 |
| PageNumbers | integer | yes | The current page number |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/610399.html operation to query region IDs |
| TemplateName | string | no | The name of the whitelist template. Specify this parameter for fuzzy match. You can call the DescribeWhitelistTemplate operation to obtain… |
| FuzzySearch | string | no | Specifies whether to enable fuzzy match. Valid values: true: Enabled. false: Disabled |
| ResourceGroupId | string | no | The ID of the resource group. For more information, see What is a resource group? |

### Queries the number of analytical instances associated with an ApsaraDB RDS for MySQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-analyticdb-by-primary-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call DescribeRegions to query the most recent region list |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to query the instance ID |

### Queries the available specifications and storage space of an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-available-classes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID |
| ZoneId | string | yes | The zone ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the zone ID. If the… |
| InstanceChargeType | string | no | The billing method of the instance. Valid values: Prepaid: subscription Postpaid: pay-as-you-go Serverless: serverless ApsaraDB RDS for… |
| Engine | string | yes | The database engine of the instance. Valid values: MySQL SQLServer PostgreSQL MariaDB |
| EngineVersion | string | yes | The database engine version of the instance. Valid values: Regular instances - MySQL: 5.5, 5.6, 5.7, and 8.0 - SQL Server: 2008r2,… |
| DBInstanceId | string | no | The instance ID. You can call the DescribeDBInstances operation to query the instance ID |
| OrderType | string | no | The order type. Set the value to BUY |
| DBInstanceStorageType | string | yes | The instance storage type. Valid values: general_essd: Premium ESSD local_ssd: premium local SSD cloud_ssd: standard SSD cloud_essd0: PL0… |
| Category | string | yes | The instance edition. Valid values: Regular instances * Basic: Basic Edition * HighAvailability: high availability series * cluster:… |
| CommodityCode | string | no | The commodity code of the instance. Valid values: bards: pay-as-you-go primary instances on the China site rds: subscription primary… |

### Queries the destination regions to which cross-region backups can be performed for a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-available-cross-region` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID |

### Retrieves all enhanced monitoring metrics supported by an ApsaraDB RDS for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-available-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | Instance ID of the instance. You can call the DescribeDBInstances operation to query instance ID |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries the time range to which data can be restored from a specified cross-region backup file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-available-recovery-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| CrossBackupId | integer | yes | The ID of the cross-region backup file. You can call the DescribeCrossRegionBackups operation to query the ID of the backup set |
| RegionId | string | no | The region ID |
| ResourceGroupId | string | no | The resource group ID |
| DBInstanceId | string | no | The instance ID. You can call the DescribeDBInstances operation to query the instance ID |

### Queries the available zone resources for ApsaraDB RDS
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-available-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID |
| Engine | string | yes | The database engine. Valid values: MySQL SQLServer PostgreSQL MariaDB |
| ZoneId | string | no | The zone ID. The format of a multi-zone ID is different from that of a single-zone ID and contains `MAZ`, such as `cn-hangzhou-MAZ6(b,f)`… |
| EngineVersion | string | no | The database engine version. Valid values: Regular instances - MySQL: 5.5, 5.6, 5.7, and 8.0 - SQL Server: 2008r2, 08r2_ent_ha, 2012,… |
| CommodityCode | string | no | The commodity code of the instance. The available resources are queried based on the specified commodity code. Valid values: bards:… |
| DispenseMode | string | no | Specifies whether to return the list of zones that support single-zone deployment. Valid values: 1 (default): Returns the list. 0: Does… |
| DBInstanceName | string | no | The instance ID of the primary instance. This parameter is used to query the available read-only instance resources under the primary… |
| Category | string | no | The instance edition. Valid values: Regular instances - Basic: Basic Edition - HighAvailability: high-availability (active) series -… |

### Queries the list of databases in a backup set
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-backup-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| BackupId | string | no | The backup set ID |

### Queries the backup settings of an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to retrieve the ID |
| BackupPolicyMode | string | no | The backup type. Valid values: DataBackupPolicy: data backup LogBackupPolicy: log backup |
| CompressType | string | no | The backup compression method. Valid values: 0: no compression 1: zlib compression 2: parallel zlib compression 4: quicklz compression… |
| ReleasedKeepPolicy | string | no | The data retention policy for archived backups of deleted MySQL instances. Valid values: None: no retention Lastest: retains the last… |

### Queries the backup tasks of an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-backup-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of… |
| Flag | string | no | The reserved parameter |
| DBInstanceId | string | yes | Instance ID of the instance. You can call the DescribeDBInstances operation to query instance ID |
| BackupJobId | integer | no | The ID of the backup task |
| BackupMode | string | no | The backup pattern. Valid values: Automated: automatic backup Manual: manual backup |
| BackupJobStatus | string | no | The status of the backup task. Valid values: NoStart: not started Progressing: in progress Default value: all statuses |

### Queries the backup sets of an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-backups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | Instance ID of the instance. You can call the DescribeDBInstances operation to query instance ID |
| BackupId | string | no | The ID of the backup set |
| BackupStatus | string | no | The status of the backup set. Valid values: Success: The backup is completed. Failed: The backup failed |
| BackupMode | string | no | The backup mode. Valid values: Automated: automatic backup Manual: manual backup |
| StartTime | string | no | The start time of the query. Specify the time in the yyyy-MM-dd T HH:mm Z format. The time must be in UTC |
| EndTime | string | no | The end time of the query. The end time must be later than the start time. Specify the time in the yyyy-MM-dd T HH:mm Z format. The time… |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The page number. Valid values: an integer greater than 0 and less than or equal to the maximum integer value. Default value: 1 |
| BackupType | string | no | The backup type. Valid values: FullBackup: full backup IncrementalBackup: incremental backup |

### Queries the binary logs of an ApsaraDB RDS for MySQL or ApsaraDB RDS for MariaDB instance, or the WAL logs…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-binlog-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to query the instance ID |
| StartTime | string | yes | The start time of the query. Format: yyyy-MM-dd T HH:mm:ss Z (UTC) |
| EndTime | string | yes | The end time of the query. The end time must be later than the start time. Format: yyyy-MM-dd T HH:mm:ss Z (UTC) |
| PageSize | integer | no | The number of entries per page. Valid values: 30 to 100. Default value: 30 |
| PageNumber | integer | no | The page number. Valid values: any integer greater than 0 that does not exceed the maximum value of Integer. Default value: 1 |

### Queries the character sets supported by an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-character-set-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| Engine | string | yes | The type of the database engine. Valid values: mysql: MySQL mssql: SQL Server PostgreSQL: PostgreSQL MariaDB: MariaDB |
| RegionId | string | yes | The region ID. You can call DescribeRegions to query the region ID |
| ResourceGroupId | string | no | The resource group ID. You can call DescribeDBInstanceAttribute to query the resource group ID |

### Queries the details of an instance type by using the instance type code
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-class-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of… |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the available region IDs |
| CommodityCode | string | yes | The commodity code. Valid values: bards: pay-as-you-go primary instance rds: subscription primary instance rords: pay-as-you-go read-only… |
| ClassCode | string | yes | The instance type code |
| EngineVersion | string | yes | The database engine version |
| Engine | string | yes | The database engine type |
| ResourceGroupId | string | no | The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the ID |

### Queries the details of the pre-check report for one-click cloud migration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-cloud-migration-precheck-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The instance ID of the target instance. You can invoke the DescribeDBInstances operation to query the instance ID |
| TaskId | integer | no | The ID of the task. You can obtain the task ID from the response message when you call the CreateCloudMigrationPrecheckTask operation to… |
| TaskName | string | no | The name of the task. You can obtain the task name from the response message when you call the CreateCloudMigrationPrecheckTask operation… |
| SourceIpAddress | string | no | The internal IP address or public IP address of the self-managed PostgreSQL database. In the one-click cloud migration scenario for a… |
| SourcePort | integer | no | The port of the self-managed PostgreSQL database. You can run the `netstat -a / grep PGSQL` command to view the port |
| PageSize | integer | yes | The number of entries per page. Valid values: 30 to 100. Default value: 30 |
| PageNumber | integer | yes | The page number. Valid values: any positive integer up to the maximum value of the Integer type. Default value: 1 |

### Queries the details of an ApsaraDB RDS for PostgreSQL cloud migration task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-cloud-migration-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The ID of the target instance. You can invoke the DescribeDBInstances operation to query the instance ID |
| TaskId | integer | no | The ID of the task. You can obtain the task ID from the response when you call the CreateCloudMigrationTask operation to create an… |
| TaskName | string | no | The name of the task. You can obtain the task name from the response when you call the CreateCloudMigrationTask operation to create an… |
| SourceIpAddress | string | no | The internal IP address of the self-managed PostgreSQL database. In the scenario of migrating a self-managed PostgreSQL database on an ECS… |
| SourcePort | integer | no | The port of the self-managed PostgreSQL database. You can run the netstat -a / grep PGSQL command to view the port |
| PageNumber | integer | yes | The page number |
| PageSize | integer | yes | The maximum number of entries per page |

### Queries the character set collations and time zones supported by ApsaraDB RDS for SQL Server
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-collation-time-zones` (byok)

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

### Queries the configuration of the committed Serverless feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-compute-burst-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of… |
| DBInstanceId | string | yes | The ID of the instance |
| ResourceGroupId | string | no | The ID of the resource group |
| RegionId | string | no | The region ID of the instance |

### Queries the database and table information of cross-region backups for an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-cross-backup-meta-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| BackupSetId | string | yes | The ID of the cross-region backup set. You can call the DescribeCrossRegionBackups operation to query the ID |
| GetDbName | string | no | The name of the database to query. Exact match is used. The specific database name and the names of tables in the database are returned |
| Pattern | string | no | The name of the database to query. Fuzzy match is used. Only the matched database names are returned, and table names are not returned.… |
| PageSize | string | no | The number of entries per page. Default value: 1. This parameter must be used together with PageIndex to take effect |
| PageIndex | string | no | The page number. Valid values: any integer greater than 0 and less than or equal to the maximum value of the Integer type. This parameter… |
| Region | string | no | The region where the instance resides |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries the instances that have cross-region backup enabled in a specified region and the cross-region…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-cross-region-backup-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceId | string | no | The instance ID. You can specify up to 30 instance IDs at a time. Separate multiple instance IDs with commas (,) |
| PageSize | integer | no | The number of entries per page. Default value: 30 |
| PageNumber | integer | no | The page number. Valid values: any integer greater than 0 and less than or equal to the maximum value of the Integer type. Default value: 1 |

### Queries the cross-region data backup files of an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-cross-region-backups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID of the instance |
| CrossBackupRegion | string | no | The ID of the destination region for cross-region backup |
| CrossBackupId | integer | no | The ID of the cross-region backup file. You must specify either CrossBackupId or the start and end time parameters (StartTime and EndTime) |
| StartTime | string | no | The start time of the query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If the time zone is not UTC+0,… |
| EndTime | string | no | The end time of the query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If the time zone is not UTC+0,… |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The page number. Valid values: any integer greater than 0 and less than or equal to the maximum value of the Integer type. Default value: 1 |
| BackupId | integer | no | The ID of the user backup |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries the list of cross-region log backup files
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-cross-region-log-backup-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID of the instance. You can call the DescribeRegions operation to query the region ID |
| CrossBackupRegion | string | no | The ID of the destination region for cross-region backup. You can call the DescribeCrossRegionBackupDBInstance operation to query the… |
| StartTime | string | yes | The start time of the query. Format: yyyy-MM-dd T HH:mm:ss Z (UTC) |
| EndTime | string | yes | The end time of the query. Format: yyyy-MM-dd T HH:mm:ss Z (UTC) |
| 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 |

### Queries the latest specification change order of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-current-modify-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of… |
| RegionId | string | yes | The region ID |
| DbInstanceId | string | yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID |
| ResourceGroupId | string | no | The resource group ID |

### Queries the resource usage of instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-custins-resource-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceIds | string | yes | The instance IDs. You can call the https://help.aliyun.com/document_detail/26232.html operation to query the instance IDs |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries the details of an ApsaraDB RDS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-dbinstance-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to obtain the instance ID. Do not specify multiple instance IDs for batch queries.… |
| Expired | string | no | The expiration status of the instance. Valid values: True: The instance has expired. False: The instance has not expired |

### Retrieves the tags bound to an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-dbinstance-by-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | Ensures the idempotence of the request and prevents duplicate submissions. The value is generated by the client and must be unique across… |
| proxyId | string | no | This parameter is deprecated |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID |
| DBInstanceId | string | no | The instance ID. You can call the DescribeDBInstances operation to query the instance ID |
| PageSize | integer | no | The number of entries per page. Valid values: 30 to 100. Default value: 30 |
| PageNumber | integer | no | The page number. Valid values: greater than 0 and less than or equal to the maximum value of the Integer type. Default value: 1 |

### Queries the column encryption algorithm configuration of a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-dbinstance-cls` (byok)

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

### Retrieves the connectivity diagnostics information for an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/describe-dbinstance-connectivity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rds.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| DbInstanceName | string | yes | The instance ID |
| SourceIpAddress | string | yes | The source IP address of the user |

…and 245 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-rds/activate-migration-target-instance" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ApsaraDB for RDS API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-rds/activate-migration-target-instance with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud ApsaraDB for RDS 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-rds.

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