DescribeCrossBackupStatistical

Download PDF

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

DescribeCrossBackupStatistical

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

Download PDF

1. API Description

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

This API is used to query the real-time statistics list of cross-region 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: DescribeCrossBackupStatistical.
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.
Offset	Yes	Integer	Pagination number.
Limit	Yes	Integer	Pagination size.
InstanceIdSet.N	No	Array of String	Instance ID list.
InstanceNameSet.N	No	Array of String	Instance name list.
CrossBackupStatus	No	String	Cross-region backup status. enable: enabled; disable: disabled.
CrossRegion	No	String	Target region for cross-region backups.
OrderBy	No	String	Sorting field. The default value is default, which indicates sorting by backup space in descending order. data - sort by data backup; log - sort by log backup.
OrderByType	No	String	Collation rule (desc - descending order; asc - ascending order). The default value is desc.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Real-time statistics on the total number of cross-region backup overview data entries.
Items	Array of CrossSummaryDetailRes	Real-time statistics list of cross-region backups.
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 Cross-Region Backups

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeCrossBackupStatistical
&InstanceIdSet.0=mssql-6upluvd5
&InstanceNameSet.0=name
&CrossBackupStatus=enable
&CrossRegion=guangzhou
&OrderBy=default
&OrderByType=desc
&Offset=0
&Limit=10
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "1fed8472-f117-11ec-be47-525400853186",
        "TotalCount": 1,
        "Items": [
            {
                "ActualUsedCount": 4937,
                "ActualUsedSpace": 554778704,
                "CrossBackupEnabled": "enable",
                "CrossBackupSaveDays": 7,
                "CrossRegions": [
                    "ap-shanghai"
                ],
                "DataBackupCount": 1019,
                "DataBackupSpace": 550868544,
                "InstanceId": "mssql-1ybz12wb",
                "LastBackupStartTime": "2022-06-21 13:57:17",
                "LogBackupCount": 3918,
                "LogBackupSpace": 3910160,
                "Name": "xinyuanxu-new",
                "Region": "ap-guangzhou",
                "Status": 2
            }
        ]
    }
}

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.DBError	Database error
InvalidParameter.InputIllegal	Input error.
InvalidParameterValue.IllegalRegion	Invalid region.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

Was this page helpful?

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

Yes

Feedback

tencent cloud