API standards and multilingual preset SDKs
The OpenAPI of this product (Dbs/2021-01-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Advanced download
|
API |
Title |
Description |
| DescribeDownloadBackupSetStorageInfo | DescribeDownloadBackupSetStorageInfo | Queries the storage information for downloading a backup set. |
| DescribeDownloadSupport | DescribeDownloadSupport | Queries whether the current instance supports the Advanced Download feature. |
| CreateDownload | CreateDownload | Create an Advanced Download Task. |
| DescribeDownloadTask | DescribeDownloadTask | Queries a list of advanced download tasks for RDS for MySQL, RDS for PostgreSQL, and PolarDB for MySQL instances. |
| RetryDownloadTask | RetryDownloadTask | Retries a failed advanced download task. |
Others
|
API |
Title |
Description |
| DescribeBackupDataList | DescribeBackupDataList | Queries backup data for a PolarDB for MySQL cluster. |
| CreateAdvancedPolicy | CreateAdvancedPolicy | Enables an advanced backup policy for a PolarDB instance. |
| DeleteSandboxInstance | DeleteSandboxInstance | Deletes a sandbox instance. |
| DescribeSandboxRecoveryTime | DescribeSandboxRecoveryTime | Queries the recoverable time range of a sandbox instance. |
| DescribeSandboxInstances | DescribeSandboxInstances | Queries sandbox instances that are created within an account. |
| DescribeSandboxBackupSets | DescribeSandboxBackupSets | Queries sandbox backup sets. |
| DescribeCostInfoByDbsInstance | DescribeCostInfoByDbsInstance | Queries the costs for a DBS instance. |
Others
|
API |
Title |
Description |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group of a resource. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the backup policy of a PolarDB instance. |
| ModifyBackupPolicy | Modify backup policy | Modifies the backup policy of a PolarDB instance. |