API overview

更新时间:
复制 MD 格式

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (Dbs/2021-01-01) 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.

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.

Other

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 for a PolarDB instance.
ModifyBackupPolicy ModifyBackupPolicy Modifies the backup policy for a PolarDB instance.