tencent cloud



Last updated: 2022-04-26 16:25:46

1. API Description

Domain name for API request: cdb.tencentcloudapi.com.

This API is used to query the backup overview of a user. It will return the user's current total number of backups, total capacity used by backups, capacity in the free tier, and paid capacity (all capacity values are in bytes).

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeBackupOverview.
Version Yes String Common Params. The value used for this API: 2017-03-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Product Yes String TencentDB product type to be queried. Currently, only mysql is supported.

3. Output Parameters

Parameter Name Type Description
BackupCount Integer Total number of backups of a user in the current region (including data backups and log backups).
BackupVolume Integer Total capacity of backups of a user in the current region.
BillingVolume Integer Paid capacity of backups of a user in the current region, i.e., capacity that exceeds the free tier.
FreeVolume Integer Backup capacity in the free tier of a user in the current region.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying backup overview

Input Example

&<Common request parameters>

Output Example

  "Response": {
    "BackupCount": 15,
    "BackupVolume": 90000,
    "BillingVolume": 20000,
    "FreeVolume": 70000,
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.CdbError System error.
InvalidParameter Parameter error.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support