This topic describes the basic information and precautions of Data Backup (DBS) API.
For information about Alibaba Cloud APIs, see Overview.
Basic information
Version description
Version number | Supported API operation |
API operations that provide features including backup task management, restoration task management, and backup set download. For more information about the API operations that are supported by this version, see List of operations by function. | |
API operations that provide features including sandbox instance management and advanced download of ApsaraDB RDS instances. For more information about the API operations that are supported by this version, see List of operations by function. |
DBS provides two versions of API operations. The features of each version are unique. You must choose the version based on your business requirements.
Endpoints
You must use an endpoint based on the region of your instance to reduce the latency. For example, if your instance resides in the China (Zhangjiakou) region, the virtual private cloud (VPC) endpointdbs-api-vpc.cn-zhangjiakou.aliyuncs.com is recommended. For more information, see Endpoints.
Format
Remote procedure call (RPC) API
Call methods
Call method | Supported | Description |
(Recommended) Alibaba Cloud SDKs | Yes | For information about DBS SDKs for different languages and dependency installation methods, see Database Backup. |
Yes | None |
If the preceding methods cannot meet your business requirements, you can encapsulate the API requests. However, this method is not recommended. For more information, see Overview.
Usage notes
If an error is returned after you call an API operation, you must check whether the values of the request parameters are valid based on the returned error code. For more information, see Database Backup - Error Codes.
You can also save the returned request ID or SDK error information and use the Alibaba Cloud OpenAPI Diagnostics tool to perform self-service diagnostics.