DescribeBackupSummary

Last updated: 2025-10-28 22:49:36

DescribeBackupSummary

Last updated: 2025-10-28 22:49:36

1. API Description

Domain name for API request: sqlserver.intl.tencentcloudapi.com.

This API is used to query the backup overview information of databases.

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: DescribeBackupSummary.
Version	Yes	String	Common Params. The value used for this API: 2018-03-28.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.

3. Output Parameters

Parameter Name	Type	Description
FreeSpace	Integer	Actual free total space, in KB.
ActualUsedSpace	Integer	Actual used space of backups, in KB.
BackupFilesTotal	Integer	Total number of backup files.
BillingSpace	Integer	Charged space of the space occupied by backups, in KB.
DataBackupSpace	Integer	Data backup usage space, in KB.
DataBackupCount	Integer	Total number of data backup files.
ManualBackupSpace	Integer	Storage space used by manual backups in data backup, in KB.
ManualBackupCount	Integer	Total number of files for manual backups in data backup.
AutoBackupSpace	Integer	Storage space used by automatic backups in data backup, in KB.
AutoBackupCount	Integer	Total number of files for automatic backups in data backup.
LogBackupSpace	Integer	Backup usage space for logs, in KB.
LogBackupCount	Integer	Total number of log backup files.
EstimatedAmount	Float	Estimated fees, in USD/hour.
LocalBackupFilesTotal	Integer	Total number of local backup files.
CrossBackupFilesTotal	Integer	Total number of cross-region backup files.
CrossBillingSpace	Integer	Charged space of the space occupied by cross-region backups, in KB.
CrossAutoBackupSpace	Integer	Space used by cross-region automatic data backups, in KB.
CrossAutoBackupCount	Integer	Total number of files for cross-region automatic data backups.
LocalLogBackupSpace	Integer	Space used by local log backups, in KB.
LocalLogBackupCount	Integer	Total number of files for local log backups.
CrossLogBackupSpace	Integer	Space used by cross-region log backups, in KB.
CrossLogBackupCount	Integer	Total number of files for cross-region log backups.
CrossEstimatedAmount	Float	Estimated fees for cross-region backups, in USD/hour.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the Backup Overview Information of Databases

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeBackupSummary
&<Common request parameters>

Output Example

{
    "Response": {
        "ActualUsedSpace": 1193345364,
        "AutoBackupCount": 1615,
        "AutoBackupSpace": 953883130,
        "BackupFilesTotal": 16637,
        "BillingSpace": 605473752,
        "CrossAutoBackupCount": 288,
        "CrossAutoBackupSpace": 146231712,
        "CrossBackupFilesTotal": 3303,
        "CrossBillingSpace": 147469692,
        "CrossEstimatedAmount": 0.114,
        "CrossLogBackupCount": 3015,
        "CrossLogBackupSpace": 1237980,
        "DataBackupCount": 2046,
        "DataBackupSpace": 1183658714,
        "EstimatedAmount": 0.4616,
        "FreeSpace": 440401920,
        "LocalBackupFilesTotal": 13334,
        "LocalLogBackupCount": 11576,
        "LocalLogBackupSpace": 8448670,
        "LogBackupCount": 14591,
        "LogBackupSpace": 9686650,
        "ManualBackupCount": 143,
        "ManualBackupSpace": 83543872,
        "RequestId": "8b5d62cb-40f4-45ba-8a26-a2083d4f9eee"
    }
}

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
FailedOperation.DBError	Database error.
FailedOperation.QueryPriceFailed	Billing error. Failed to query price.
InternalError	Internal error.
InternalError.DBError	Database error
InternalError.UnknownError	Unknown error.
InvalidParameterValue.IllegalRegion	Invalid region.
ResourceNotFound.AccountNotExist	The account does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud