DescribeBackupSummaries

最后更新时间：2024-01-30 10:26:31

1. API Description

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

This API is used to query the statistics of backups. It will return the capacity used by backups at the instance level and the number and used capacity of data backups and log backups of each instance (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: DescribeBackupSummaries.
Version	Yes	String	Common Params. The value used for this API: 2017-03-20.
Region	No	String	Common Params. This parameter is not required for this API.
Product	Yes	String	TencentDB product type to be queried. Currently, only `mysql` is supported.
Offset	No	Integer	Paginated query offset. Default value: `0`.
Limit	No	Integer	Maximum entries returned per page, which ranges from 1 to 100. Default value: `20`.
OrderBy	No	String	Sorting criterion. Valid values: `BackupVolume` (backup capacity), `DataBackupVolume` (data backup capacity), `BinlogBackupVolume` (log backup capacity), `AutoBackupVolume` (automatic backup capacity), `ManualBackupVolume` (manual backup capacity). Default value: `BackupVolume`.
OrderDirection	No	String	Sorting order. Valid values: `ASC` (ascending), `DESC` (descending). Default value: `ASC`.

3. Output Parameters

Parameter Name	Type	Description
Items	Array of BackupSummaryItem	Statistical items of instance backup.
TotalCount	Integer	Total number of instance backups.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the real-time backup statistics

This example shows you how to query the real-time backup statistics.

Input Example

POST / HTTP/1.1Host: cdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeBackupSummaries<Common request parameters>{    "Product": "mysql",    "Limit": "1"}

Output Example

{
    "Response": {
        "Items": [
            {
                "AutoBackupCount": 5,
                "AutoBackupVolume": 10000,
                "BackupVolume": 50000,
                "BinlogBackupCount": 2,
                "BinlogBackupVolume": 20000,
                "DataBackupCount": 15,
                "DataBackupVolume": 30000,
                "InstanceId": "cdb-01wa5l0v",
                "ManualBackupCount": 10,
                "ManualBackupVolume": 20000
            }
        ],
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "TotalCount": 50
    }
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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
AuthFailure	CAM signature/authentication error.
AuthFailure.SubAccountDenied	The sub-account has no permissions.
InternalError.CdbError	System error.
InternalError.DBError	Database exception
InvalidParameter	Parameter error.
InvalidParameter.ControllerNotFoundError	This API was not found.
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value
OperationDenied.SubAccountOperationDenied	The Tencent Cloud sub-account is not allowed to perform the operation due to insufficient permissions.

tencent cloud

Recent Pages