# Alibaba Cloud ApsaraDB for SelectDB API

> Alibaba Cloud ApsaraDB for SelectDB API on Apizie: 52 endpoints (Applies for a public endpoint for a specified ApsaraDB for SelectDB instance, Moves an instance to a different resource group, Performs a precheck before you create an ApsaraDB for SelectDB instance, Checks whether a specified IP address already exists in a network whitelist group, …) 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://apizie.tech/v1/cloud:aliyun-selectdb/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-selectdb`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/selectdb
- Page: https://apizie.tech/api/cloud/aliyun-selectdb
- OpenAPI: https://apizie.tech/api/cloud/aliyun-selectdb/openapi.json

Alibaba Cloud OpenAPI for ApsaraDB for SelectDB (selectdb, version 2023-05-22). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Applies for a public endpoint for a specified ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/allocate-instance-public-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| NetType | string | yes | The network type of the new endpoint. Set the value to Public |
| ConnectionStringPrefix | string | yes | The prefix of the target endpoint, which is the prefix part of the ConnectionString parameter |
| RegionId | string | yes | The region ID |

### Moves an instance to a different resource group
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| ResourceType | string | no | The resource type |
| ResourceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| ResourceGroupId | string | yes | The ID of the target resource group |

### Performs a precheck before you create an ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/check-create-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| ClientToken | string | no | The client token that is used to ensure the idempotency of the request. You can use the client to generate the token, but you must make… |
| Engine | string | no | The database engine type |
| EngineVersion | string | yes | The database engine version |
| ChargeType | string | yes | The billing method of the instance. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription |
| UsedTime | integer | no | The subscription duration of the instance. The unit is specified by Period. Year indicates years and Month indicates months. Valid values:… |
| Period | string | no | Specifies whether the upfront subscription cluster uses a yearly or monthly billing cycle. Valid values: Year: yearly billing cycle.… |
| DBInstanceClass | string | yes | The instance type. Valid values: selectdb.xlarge: 4 cores, 32 GB memory. selectdb.2xlarge: 8 cores, 64 GB memory. selectdb.4xlarge: 16… |
| RegionId | string | yes | The region ID |
| ZoneId | string | yes | The zone ID |
| CacheSize | integer | yes | The reserved cache size. Unit: GB |
| VpcId | string | yes | VPC ID |
| VSwitchId | string | yes | The vSwitch ID |
| DBInstanceDescription | string | no | The description of the instance |
| ConnectionString | string | no | The endpoint of the instance |
| SecurityIPList | string | no | The IP address whitelist of the instance. Separate multiple IP addresses with commas (,) |

### Checks whether a specified IP address already exists in a network whitelist group
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/check-ip-exists-in-security-ip-list` (byok)

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

### Checks the service-linked role
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/check-service-linked-role` (byok)

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

### Creates a cluster for a specified ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/create-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| Engine | string | no | The database type |
| EngineVersion | string | yes | The database version |
| ChargeType | string | yes | The billing method of the cluster. Valid values: Postpaid: pay-as-you-go Prepaid: subscription |
| UsedTime | string | no | Specifies the purchase duration of the subscription cluster. The unit is specified by Period: Year indicates years, and Month indicates… |
| Period | string | no | Specifies whether the subscription cluster is billed on a yearly or monthly basis. Valid values: Year: yearly Month: monthly This… |
| DBClusterClass | string | yes | The cluster specifications. Valid values: selectdb.xlarge: 4 cores and 32 GB memory selectdb.2xlarge: 8 cores and 64 GB memory… |
| RegionId | string | yes | The region ID |
| ZoneId | string | yes | The zone ID |
| VpcId | string | yes | The VPC ID |
| VSwitchId | string | yes | The vSwitch ID |
| CacheSize | string | yes | The reserved cache size |
| DBClusterDescription | string | yes | The cluster description |
| ClusterNodeType | string | no | The node type of the cluster. This parameter takes effect only in Serverless mode |
| ClusterNodeCount | integer | no | The number of nodes in the cluster. This parameter takes effect only in Serverless mode |
| ScaleMax | number | no | The maximum value of the auto-scaling range for the instance RCU (RDS Capacity Unit) |
| ScaleMin | number | no | The minimum value of the auto-scaling range for the instance RCU (RDS Capacity Unit) |

### Creates a binding relationship between two clusters for an instance deployed in cross-zone redundancy mode
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/create-dbcluster-binding` (byok)

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

### Creates an ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/create-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group |
| 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… |
| Engine | string | no | The database engine type. Default value: selectdb |
| EngineVersion | string | yes | The database engine version. Default value: 4.1. Valid values: 4.0 4.1 |
| ChargeType | string | yes | The billing method of the instance. Valid values: Postpaid: pay-as-you-go Prepaid: subscription |
| UsedTime | integer | no | The subscription duration of the instance. The unit is specified by the Period parameter. Year indicates years, and Month indicates… |
| Period | string | no | Specifies the billing cycle of the subscription cluster. Valid values: Year: yearly. Month: monthly. This parameter takes effect and is… |
| DBInstanceClass | string | yes | The instance type. You can call the https://help.aliyun.com/document_detail/2853363.html operation to query instance types |
| RegionId | string | yes | The region ID |
| ZoneId | string | yes | The zone ID |
| CacheSize | integer | yes | The reserved cache size |
| VpcId | string | yes | The VPC ID |
| VSwitchId | string | yes | The vSwitch ID |
| DBInstanceDescription | string | no | The description of the instance |
| ConnectionString | string | no | The database endpoint |
| SecurityIPList | string | no | The IP address whitelist of the instance. Separate multiple IP addresses with commas (,) |
| Tag | string | no | The tag list information of the instance (JSON-encoded) |
| DeployScheme | string | no | The deployment mode of the instance |
| MultiZone | string | no | The multi-zone configuration. This parameter takes effect and is required when DeployScheme is set to multi_az (JSON-encoded) |
| AddVPCIPs | string | no | Specifies whether to add the VPC CIDR block to the whitelist. Valid values: 1: yes 0: no |
| ClusterNodeType | string | no | The cluster node type. This parameter takes effect only in Serverless mode |
| ClusterNodeCount | integer | no | The number of cluster nodes. This parameter takes effect only in Serverless mode |
| ScaleMax | number | no | The maximum value of the automatic scaling range for the RCU (RDS Capacity Unit) of the instance |
| ScaleMin | number | no | The minimum value of the automatic scaling range for the RCU (RDS Capacity Unit) of the instance |
| ConfigPatternType | string | no | The configuration template applied to the instance |
| FEClassCode | string | no | The node specifications of a single node in the frontend (FE) cluster. This parameter takes effect only when you create a pay-as-you-go or… |
| FENodeCount | string | no | The number of nodes in the FE cluster. This parameter takes effect only when you create a pay-as-you-go or subscription instance. Default… |
| TdeMode | string | no | The mode for enabling Transparent Data Encryption (TDE) on the instance |
| TdeEnabled | string | no | Specifies whether to enable TDE on the instance |

### Creates a time-based elastic rule
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/create-elastic-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| DbInstanceId | string | yes | The instance ID |
| ClusterId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID |
| ElasticRuleStartTime | string | yes | The start time of the time-based elastic rule. The time is in the HH:mm format |
| ExecutionPeriod | string | yes | The execution period |
| ClusterClass | string | yes | The target compute resource rule of the cluster |

### Creates a service-linked role
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/create-service-linked-role-for-select-db` (byok)

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

### Creates a virtual cluster
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/create-virtual-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| ClusterName | string | yes | The instance name. Naming rules: must start with a letter, can contain up to 64 characters, and can include letters (case-insensitive),… |
| ActiveClusterId | string | yes | The primary cluster ID |
| StandbyClusterId | string | yes | The secondary cluster ID |

### Deletes a cluster from an instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/delete-dbcluster` (byok)

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

### Deletes the mutual backup binding relationship between two clusters
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/delete-dbcluster-binding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| DBClusterId | string | yes | The cluster ID |
| DBClusterIdBak | string | yes | The ID of the other cluster in the binding relationship |
| RegionId | string | no | The region ID |

### Deletes a specified ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/delete-dbinstance` (byok)

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

### Deletes a time-based elastic scaling rule
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/delete-elastic-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| Product | string | no | The cloud service type |
| DbInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| ClusterId | string | yes | The cluster ID |
| RuleId | integer | yes | The rule ID |

### Deletes a virtual cluster
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/delete-virtual-cluster` (byok)

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

### Retrieves information about all instance types
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-all-dbinstance-class` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceId | string | no | The SelectDB instance ID. This parameter is required when you create a cluster or change the specifications of a cluster |

### Queries the configuration information about a cluster in an ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-dbcluster-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| ConfigKey | string | yes | The configuration file to be modified. For a compute cluster, set the value to be.conf. For a frontend (FE) cluster, set the value to… |
| DBClusterId | string | yes | The cluster ID |
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | no | The region ID |

### Queries the configuration change records of a cluster
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-dbcluster-config-change-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| ConfigKey | string | no | The configuration file that was modified. For compute clusters, this value is fixed as be.conf. For FE clusters, this value is fixed as… |
| DBClusterId | string | yes | The cluster ID |
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| StartTime | string | yes | The start time for querying change records. Format: yyyy-MM-dd HH:mm:ss |
| EndTime | string | yes | The end time for querying change records. Format: yyyy-MM-dd HH:mm:ss |

### Retrieves the cache limits for each specification of a cluster
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-dbcluster-storage-limitation` (byok)

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

### Queries the details of an instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-dbinstance-attribute` (byok)

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

### Queries the network information of a specified ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-dbinstance-net-info` (byok)

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

### Queries the list of instances
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-dbinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group |
| DBInstanceIds | string | no | The IDs of the instances. Separate multiple instance IDs with commas (,) |
| DBInstanceStatus | string | no | The status of the instance. Valid values: CREATING: Creating. ACTIVATION: Running. RESOURCE_CHANGING: Changing specifications.… |
| DBInstanceDescription | string | no | The description of the instance |
| PageSize | integer | no | The number of entries per page. Valid values: 30 (default) 50 100 |
| PageNumber | integer | no | The page number |
| RegionId | string | yes | The region ID |
| Tag | string | no | The instance tags (JSON-encoded) |

### Queries the time-based elastic rules
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-elastic-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| Product | string | no | The cloud service type |
| DbInstanceId | string | yes | The instance ID |
| ClusterId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID |

### Retrieves the Profile analysis for a query
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-profile` (byok)

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

### Retrieves the EXPLAIN plan for a query
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-query-explain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The database instance ID |
| RegionId | string | yes | The region ID |
| QueryId | string | no | The query ID |
| Mode | string | no | The EXPLAIN mode |

### Retrieves information about available regions and zones
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-regions` (byok)

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

### Queries the IP address whitelist of a specified ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-security-iplist` (byok)

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

### Retrieves slow query statistics within a specified time period
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-slow-query-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| StartTime | string | no | The start time. Default value: 24 hours ago. Format: YYYY-MM-DD HH:mm:ss |
| EndTime | string | no | The end time. It must be later than the start time. Default value: the current time. Format: YYYY-MM-DD HH:mm:ss |
| ThresholdMs | integer | no | The slow query threshold in milliseconds. Default value: 5000 |
| TopN | integer | no | The number of top slow queries to return. Default value: 10 |

### Retrieves the CREATE TABLE statement
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-table-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| Database | string | yes | The database name |
| Table | string | yes | The table name |

### Lists vSwitches in a zone
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-vswitches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| VpcId | string | yes | The VPC ID of the instance |
| ZoneId | string | yes | The zone ID |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number |
| MaxResults | integer | no | The number of entries per page for a paged query. This is a reserved parameter and is not supported. |
| NextToken | string | no | The token for the next query. This is a reserved parameter and is not supported. |

### Lists available zones for sale
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/describe-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| MaxResults | integer | no | If you do not specify the MaxResults request parameter, paged queries are not performed. The MaxResults value in the response indicates… |
| NextToken | string | no | The token for the next query |

### Enables or disables a time-based elastic policy
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/en-disable-scaling-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| Product | string | no | The cloud service type |
| DbInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| ClusterId | string | yes | The cluster ID |
| ScalingRulesEnable | string | yes | Specifies whether the time-based elastic policy is enabled |

### Retrieves the pricing information for creating a cluster in a specified ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/get-create-becluster-inquiry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| CommodityCode | string | no | The commodity code |
| ChargeType | string | yes | The billing method |
| PricingCycle | string | yes | The billing cycle |
| Quantity | integer | yes | The quantity |
| PreCacheSize | integer | no | The reserved cache space |
| PreComputeSize | integer | no | The reserved compute resources |
| CacheSize | integer | no | The elastic cache space |
| ComputeSize | integer | no | The elastic compute resources |
| DbInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| PromotionOptionNo | string | no | The coupon code |

### Retrieves pricing information when creating a cluster under a specified ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/get-modify-becluster-inquiry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| ClusterId | string | no | The cluster ID |
| CommodityCode | string | yes | The commodity code |
| ChargeType | string | yes | The billing type |
| PricingCycle | string | yes | The billing cycle |
| Quantity | integer | yes | The quantity |
| PreCacheSize | integer | no | The reserved cache space |
| PreComputeSize | integer | no | The reserved compute resources |
| CacheSize | integer | no | The elastic cache space |
| ComputeSize | integer | no | The elastic compute resources |
| DbInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| ModifyClusterChargeType | string | no | Specifies whether to query the price for converting the cluster billing type |
| PromotionOptionNo | string | no | The coupon code |

### Modifies the cluster name of an ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/modify-becluster-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The instance ID |
| DBClusterId | string | yes | The cluster ID |
| InstanceAttributeType | string | yes | The type of the attribute to modify. Set the value to DBInstanceDescription |
| Value | string | yes | The new cluster name |

### Scales the cluster of a specified ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/modify-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The cluster ID |
| DBClusterClass | string | yes | The cluster specifications. Valid values: selectdb.xlarge: 4 cores and 32 GB. selectdb.2xlarge: 8 cores and 64 GB. selectdb.4xlarge: 16… |
| Engine | string | no | The database engine type. Set the value to selectdb |
| CacheSize | string | no | The reserved cache size |
| ClusterNodeType | string | no | The cluster node type. This parameter takes effect only in Serverless mode |
| ClusterNodeCount | integer | no | The number of cluster nodes. This parameter takes effect only in Serverless mode |
| ScaleMax | number | no | The maximum value of the auto-scaling range for the instance RCU (RDS Capacity Unit) |
| ScaleMin | number | no | The minimum value of the auto-scaling range for the instance RCU (RDS Capacity Unit) |

### Modifies the configuration of a cluster
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/modify-dbcluster-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| Parameters | string | yes | The JSON string of parameters and parameter values |
| ConfigKey | string | yes | The configuration file to modify. Set this parameter to be.conf for compute clusters or fe.conf for FE clusters |
| DBClusterId | string | yes | The cluster ID |
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | no | The region ID |
| SwitchTimeMode | string | no | The upgrade mode. If this parameter is not specified, the upgrade takes effect immediately. Set this parameter to 1 to perform the upgrade… |
| ParallelOperation | string | no | Specifies whether to perform operations on cluster nodes in parallel |

### Modifies the O&M time or description of a specified ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/modify-dbinstance-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The instance ID |
| InstanceAttributeType | string | yes | The attribute to modify. Valid values: MaintainTime: modifies the O&M time. The format is hh:mm-hh:mm. DBInstanceDescription: modifies the… |
| Value | string | yes | The new value of the attribute. Valid values: If InstanceAttributeType is set to MaintainTime, set this parameter to a time range such as… |

### Modifies a time-based elastic rule
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/modify-elastic-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| Product | string | no | The cloud service type |
| DbInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| ClusterId | string | yes | The cluster ID |
| RuleId | integer | yes | The rule ID |
| ElasticRuleStartTime | string | no | The start time of the time-based elastic rule. The time is in the HH:mm format |
| ExecutionPeriod | string | no | The execution period |
| ClusterClass | string | no | The target compute resource rule for the cluster |

### Modifies the IP addresses in the whitelist of a specified ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/modify-security-iplist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The instance ID |
| GroupName | string | yes | The name of the whitelist group. By default, the Default group is modified |
| SecurityIPList | string | yes | The IP addresses in the whitelist of the instance. Separate multiple IP addresses with commas (,) |
| ModifyMode | string | yes | The modification mode of the whitelist. Valid values: 0: Overwrites the original whitelist. 1: Adds IP addresses to the whitelist. 2:… |

### Modifies a virtual cluster
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/modify-virtual-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| DBClusterId | string | yes | The virtual cluster ID |
| RegionId | string | yes | The region ID |
| ActiveClusterId | string | no | The primary cluster ID |
| StandbyClusterId | string | no | The secondary cluster ID |

### Releases the public endpoint of an ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/release-instance-public-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| ConnectionString | string | yes | The connection string of the instance |
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID of the instance |

### Resets the account password of an ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/reset-account-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceId | string | yes | The instance ID |
| AccountName | string | yes | The database account |
| AccountPassword | string | yes | The password of the database account. The password must meet the following requirements: Contains at least three of the following… |

### Restarts a cluster of a specified ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/restart-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The cluster ID |
| ParallelOperation | string | no | Specifies whether to perform operations on cluster nodes in parallel |

### Starts a specified ApsaraDB for SelectDB cluster
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/start-becluster` (byok)

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

### Stops a specified ApsaraDB for SelectDB cluster
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/stop-becluster` (byok)

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

### Adds tags to instances
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| ResourceType | string | yes | The resource type |
| ResourceId | string | yes | The list of instance IDs (JSON-encoded) |
| RegionId | string | yes | The region ID |
| Tag | string | yes | The list of tags (JSON-encoded) |

### Removes tags from an instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| ResourceType | string | yes | The resource type |
| ResourceId | string | no | The list of instance IDs (JSON-encoded) |
| RegionId | string | yes | The region ID |
| TagKey | string | no | The list of tag keys (JSON-encoded) |
| All | string | no | Specifies whether to remove all tags from the instance. This parameter takes effect only when TagKey is not specified. Default value: false |

### Upgrades a locally redundant instance to zone-redundant deployment
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/upgrade-dbinstance-deploy-scheme` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region in which the instance resides |
| DBInstanceId | string | yes | The instance ID |
| MultiZone | string | yes | The list of multiple zones (JSON-encoded) |

### Upgrades the database version of a specified ApsaraDB for SelectDB instance
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/upgrade-dbinstance-engine-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://selectdb.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID |
| EngineVersion | string | yes | The database version |
| SwitchTimeMode | string | no | The upgrade mode. If you leave this parameter empty, the upgrade is performed immediately. If you set this parameter to 1, the upgrade is… |
| ParallelOperation | string | no | Specifies whether to perform operations on cluster nodes in parallel |

### version
`POST https://apizie.tech/v1/cloud:aliyun-selectdb/version` (byok)

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

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-selectdb/allocate-instance-public-connection" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ApsaraDB for SelectDB API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-selectdb/allocate-instance-public-connection with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud ApsaraDB for SelectDB 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 SelectDB itself also needs your own key from aliyuncs.com.

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

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