API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (cddc/2020-03-20) 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. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Proprietary API
|
API |
Title |
Description |
| CreateMyBase | CreateMyBase | Create MyBase dedicated hosts. If cluster information is not provided, a MyBase dedicated cluster is automatically created. |
Open API
|
API |
Title |
Description |
| AddPrinsInstance | AddPrinsInstance | Adds a self-managed MyBase instance. |
| CreatePrinsBackupPlan | CreatePrinsBackupPlan | Creates a backup plan for a managed instance. |
| DescribePrinsInstance | DescribePrinsInstance | Retrieves the details of a managed instance. |
| DescribePrinsBackupPlan | DescribePrinsBackupPlan | Queries a DBS backup plan created on the MyBase managed instance page. An empty response indicates that no backup plan has been created for the managed instance. |
| DescribePrinsEcsInstances | DescribePrinsEcsInstances | Queries a list of ECS instance information. |
| GetPrinsEventList | GetPrinsEventList | Retrieves a list of events. |
| GetPrinsMetricsList | GetPrinsMetricsList | Retrieves performance metric data for managed instances. |
| ListPrinsSQLErrorLog | ListPrinsSQLErrorLog | Retrieves log information for a managed instance. |
| ListPrinsParams | ListPrinsParams | Queries the parameter list of a managed database instance. |
| ListPrinsInstances | ListPrinsInstances | Queries the list of managed instances. |
Others
|
API |
Title |
Description |
| CreateDedicatedHost | CreateDedicatedHost | Creates hosts in a dedicated cluster. |
| CreateDedicatedHostAccount | CreateDedicatedHostAccount | Creates an account for a host. |
| CreateDedicatedHostGroup | CreateDedicatedHostGroup | Creates a dedicated cluster. |
| DeleteDedicatedHostAccount | DeleteDedicatedHostAccount | Deletes a host account. |
| DeleteDedicatedHostGroup | DeleteDedicatedHostGroup | Deletes a dedicated cluster. |
| DescribeDedicatedHostAttribute | DescribeDedicatedHostAttribute | Queries the parameter settings of a host in a dedicated cluster. |
| DescribeDedicatedHostDisks | DescribeDedicatedHostDisks | Queries the information about disks on a host. |
| DescribeDedicatedHostGroups | Query dedicated cluster host group information | Retrieves dedicated host group information for ApsaraDB for MyBase. |
| DescribeDedicatedHosts | DescribeDedicatedHosts | Queries the information about hosts in a dedicated cluster. |
| DescribeHostEcsLevelInfo | DescribeHostEcsLevelInfo | Queries the information about host specifications. |
| DescribeHostWebShell | DescribeHostWebShell | Queries the URL of a webshell that is used to access a host. |
| DescribeRegions | DescribeRegions | Queries the most recent region list. |
| ListTagResources | ListTagResources | Queries the information about tags that are added to hosts. |
| ModifyDedicatedHostAccount | ModifyDedicatedHostAccount | Changes the account name and password of a host. |
| ModifyDedicatedHostAttribute | ModifyDedicatedHostAttribute | Specifies whether instances can be deployed on a host in a dedicated cluster. |
| ModifyDedicatedHostClass | ModifyDedicatedHostClass | Upgrades host specifications. |
| ModifyDedicatedHostGroupAttribute | ModifyDedicatedHostGroupAttribute | Modifies configurations such as the CPU overcommit ratio, memory usage, storage overcommit ratio, and resource allocation policy for a dedicated cluster. |
| ModifyDedicatedHostPassword | ModifyDedicatedHostPassword | Changes the root account password of a host. |
| QueryHostBaseInfoByInstance | QueryHostBaseInfoByInstance | Queries the basic information about the host on which an instance is deployed. |
| QueryHostInstanceConsoleInfo | QueryHostInstanceConsoleInfo | Queries the information about instances that are deployed on a host. |
| ReplaceDedicatedHost | ReplaceDedicatedHost | Replaces a host in a dedicated cluster. |
| RestartDedicatedHost | RestartDedicatedHost | Restarts a host in a dedicated cluster. |
| TagResources | TagResources | Adds tags to hosts. |
| UntagResources | UntagResources | Removes tags from hosts. |