DescribeBackupStatistical

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

DescribeBackupStatistical

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 real-time statistics list of backups.

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: DescribeBackupStatistical.
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.
Limit	Yes	Integer	The number of returned entries per page in pagination mode. Value range: 1-100. The default value is 100.
Offset	Yes	Integer	Page number in pagination mode. The default value is 0.
InstanceIdSet.N	No	Array of String	One or more instance IDs. The instance ID is in the format of mssql-si2823jyl.
InstanceNameSet.N	No	Array of String	Instance name list. Fuzzy query is supported.
OrderBy	No	String	Sorting field. The default value is default, which indicates sorting by backup space in descending order. default - sort by backup space; data - sort by data backup; log - sort by log backup; auto - sort by automatic backup; manual - sort by manual backup.
OrderByType	No	String	The default value is desc. [desc - descending order; asc - ascending order].

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of instances meeting conditions. When results are returned in pagination mode, this value refers to the total number of instances that meet conditions, rather than the number of instances returned based on the specified Limit and Offset values.
Items	Array of SummaryDetailRes	Instance list.
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 Real-Time Statistics List of Backups

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeBackupStatistical
&InstanceIdSet.0=mssql-3l3fgqn7
&InstanceNameSet.0=xinyuan
&Offset=0
&Limit=3
&OrderBy=data
&OrderByType=desc
&<Common request parameters>

Output Example

{
    "Response": {
        "Items": [
            {
                "ActualUsedSpace": 1003844420,
                "AutoBackupCount": 9190,
                "AutoBackupSpace": 920300548,
                "DataBackupCount": 1706,
                "DataBackupSpace": 996004980,
                "InstanceId": "mssql-1ybz12wb",
                "LogBackupCount": 7627,
                "LogBackupSpace": 7839440,
                "ManualBackupCount": 143,
                "ManualBackupSpace": 83543872,
                "Name": "xinyuanxu-new",
                "Region": "ap-guangzhou",
                "RegionId": 1,
                "Status": 2
            }
        ],
        "RequestId": "c3ea3ea0-f0a2-11ec-94dd-525400853186",
        "TotalCount": 17
    }
}

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.
InternalError	Internal error.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

Was this page helpful?

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

Yes

Feedback

tencent cloud