tencent cloud

DescribeBackupMonitor
Last updated: 2025-10-28 22:49:36
DescribeBackupMonitor
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 backup space usage details.

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: DescribeBackupMonitor.
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.
StartTime Yes String Sets the start time for querying backup space usage details.
EndTime Yes String End time of backup space usage.
Type No String Backup trend query type. local - local backup; cross - cross-region backup.

3. Output Parameters

Parameter Name Type Description
TimeStamp Array of String Backup trend chart timeline.
FreeSpace Array of Float Free backup space.
ActualUsedSpace Array of Float Actual total backup space.
LogBackupSpace Array of Float Backup space for logs.
DataBackupSpace Array of Float Backup space for data.
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 Backup Space Usage Details

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeBackupMonitor
&StartTime=2018-03-28 00:00:00
&EndTime=2018-04-20 00:00:00
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "863b2797-858b-49f3-88e9-50159e564cbc",
        "ActualUsedSpace": [
            1012900,
            1012900,
            1013190,
            1013190,
            1013190,
            1014280,
            1014280,
            1014280,
            1014570,
            1014570,
            1015680,
            1015680
        ],
        "DataBackupSpace": [
            512860,
            512860,
            512860,
            512860,
            512860,
            512860,
            512860,
            512860,
            512860,
            512860,
            512860,
            512860
        ],
        "FreeSpace": [
            1352663040,
            1352663040,
            1352663040,
            1352663040,
            1352663040,
            1352663040,
            1352663040,
            1352663040,
            1352663040,
            1352663040,
            1352663040,
            1352663040
        ],
        "LogBackupSpace": [
            500040,
            500040,
            500330,
            500330,
            500330,
            501420,
            501420,
            501420,
            501710,
            501710,
            502820,
            502820
        ],
        "TimeStamp": [
            "2022-05-06 09:15:00",
            "2022-05-06 09:20:00",
            "2022-05-06 09:25:00",
            "2022-05-06 09:30:00",
            "2022-05-06 09:35:00",
            "2022-05-06 09:40:00",
            "2022-05-06 09:45:00",
            "2022-05-06 09:50:00",
            "2022-05-06 09:55:00",
            "2022-05-06 10:00:00",
            "2022-05-06 10:05:00",
            "2022-05-06 10:10:00"
        ]
    }
}

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

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
FailedOperation.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
No

Feedback