API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (selectdb/2023-05-22) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
instance management
|
API |
Title |
Description |
| CreateDBInstance | CreateDBInstance | Creates an ApsaraDB for SelectDB instance. |
| CreateServiceLinkedRoleForSelectDB | CreateServiceLinkedRoleForSelectDB | Call this operation to create a service-linked role. |
| CheckServiceLinkedRole | CheckServiceLinkedRole | Call this operation to check the service-linked role. |
| CheckCreateDBInstance | CheckCreateDBInstance | Performs a precheck before creating an ApsaraDB SelectDB instance. |
| DescribeDBInstances | DescribeDBInstances | Queries the details of one or more instances. |
| DescribeDBInstanceAttribute | DescribeDBInstanceAttribute | This operation queries the details of an instance. |
| ResetAccountPassword | ResetAccountPassword | Resets the password for a database account in an ApsaraDB for SelectDB instance. |
| DescribeDBInstanceNetInfo | DescribeDBInstanceNetInfo | Queries the network information of a specified ApsaraDB SelectDB instance. |
| CheckIpExistsInSecurityIpList | CheckIpExistsInSecurityIpList | Checks whether a specified IP address exists in a whitelist group. |
| UpgradeDBInstanceEngineVersion | UpgradeDBInstanceEngineVersion | Upgrades the database version of a specified ApsaraDB SelectDB instance. |
| DeleteDBInstance | DeleteDBInstance | Deletes a specified ApsaraDB SelectDB instance. |
Cluster Management
|
API |
Title |
Description |
| DeleteVirtualCluster | DeleteVirtualCluster | Deletes a virtual cluster. |
| ModifyVirtualCluster | ModifyVirtualCluster | Modifies a virtual cluster. |
| CreateVirtualCluster | CreateVirtualCluster | Creates a virtual cluster. |
| CreateDBCluster | CreateDBCluster | Creates a cluster for a specified ApsaraDB for SelectDB instance. |
| GetCreateBEClusterInquiry | GetCreateBEClusterInquiry | Queries pricing information for creating a new cluster in a SelectDB instance. |
| GetModifyBEClusterInquiry | GetModifyBEClusterInquiry | Retrieves the pricing information for creating a new cluster within a specified ApsaraDB for SelectDB instance. |
| ModifyDBCluster | ModifyDBCluster | Scales out or in a specified ApsaraDB for SelectDB cluster. |
| ModifyBEClusterAttribute | ModifyBEClusterAttribute | Modifies the name of the BE cluster of an ApsaraDB for SelectDB instance. |
| StopBECluster | StopBECluster | Stops a specified ApsaraDB SelectDB cluster. |
| StartBECluster | StartBECluster | Starts a specified ApsaraDB SelectDB cluster. |
| RestartDBCluster | RestartDBCluster | Restarts the cluster of a specified ApsaraDB for SelectDB instance. |
| DeleteDBCluster | DeleteDBCluster | Deletes a cluster in an instance. |
| ModifyDBClusterConfig | ModifyDBClusterConfig | Modifies the configuration of a cluster. |
Others
|
API |
Title |
Description |
| ChangeResourceGroup | ChangeResourceGroup | Moves a specified database instance to a different resource group.Changes the resource group of an instance. |
| DescribeAllDBInstanceClass | DescribeAllDBInstanceClass | Retrieves all instance type information. |
| CreateElasticRule | CreateElasticRule | Creates a time-based scaling rule. |
| TagResources | TagResources | Adds tags to one or more instances. |
| AllocateInstancePublicConnection | AllocateInstancePublicConnection | Applies for a public endpoint for an ApsaraDB for SelectDB instance. |
| CreateDBClusterBinding | CreateDBClusterBinding | Creates a binding relationship for clusters. If the zone-redundant storage (ZRS) deployment method is used, you can create a binding relationship between two clusters. |
| DeleteDBClusterBinding | DeleteDBClusterBinding | Deletes the binding relationship between two clusters for mutual backup. |
| DeleteElasticRule | DeleteElasticRule | Deletes a scheduled scaling rule. |
| DescribeDBClusterConfig | DescribeDBClusterConfig | Queries the configuration information about a cluster in an ApsaraDB for SelectDB instance. |
| DescribeDBClusterConfigChangeLogs | DescribeDBClusterConfigChangeLogs | Queries the configuration change logs of a cluster. |
| DescribeElasticRules | DescribeElasticRules | Queries scheduled scaling rules. |
| DescribeRegions | DescribeRegions | Queries available regions and zones. |
| DescribeSecurityIPList | DescribeSecurityIPList | Queries the IP addresses in the whitelists of an ApsaraDB for SelectDB instance. |
| EnDisableScalingRules | EnDisableScalingRules | Uses the scheduled scaling policy. |
| ModifyDBInstanceAttribute | ModifyDBInstanceAttribute | Modifies the maintenance window or description of an ApsaraDB for SelectDB instance. |
| ModifyElasticRule | ModifyElasticRule | Modifies a scheduled scaling rule. |
| ModifySecurityIPList | ModifySecurityIPList | Modifies the IP addresses in a whitelist of an ApsaraDB for SelectDB instance. |
| ReleaseInstancePublicConnection | ReleaseInstancePublicConnection | Releases the public endpoint of an ApsaraDB for SelectDB instance. |