Last updated: 2019-09-09 14:59:28


1. API Description

API domain name:

This API (DescribeBackups) describes the backups list.

API request rate limit: 20 requests/sec.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter. The name of this API: DescribeBackups
Version Yes String Common parameter. The version of this API: 2018-03-28
Region Yes String Common parameter. For more information, see the list of regions supported by the product.
StartTime Yes Timestamp Start time (yyyy-MM-dd HH:mm:ss)
EndTime Yes Timestamp End time (yyyy-MM-dd HH:mm:ss)
InstanceId Yes String Instance ID in the format of mssql-njj2mtpl
Limit No Integer Number of results per page; 20 by default, up to 100
Offset No Integer Offset. 0 by default

3. Output Parameters

Parameter name Type Description
TotalCount Integer Total number of backups
Backups Array of Backup Backup list details
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Sample 1. Querying the Backup List

Input Sample Code
&StartTime=2018-03-28 00:00:00
&EndTime=2018-04-20 00:00:00
&<Common request parameter>

Output Sample Code

  "Response": {
    "RequestId": "863b2797-858b-49f3-88e9-50159e564cbc",
    "TotalCount": 2,
    "Backups": [
        "Id": 49760,
        "FileName": "manual_instance_58001_20180702160920.bak.tar",
        "StartTime": "2018-07-02 16:09:20",
        "EndTime": "2018-07-02 16:09:20",
        "Size": 192,
        "Strategy": 0,
        "Status": 1,
        "DBs": [
        "InternalAddr": "",
        "ExternalAddr": ""
        "Id": 49759,
        "FileName": "manual_instance_58001_20180702010430.bak.tar",
        "StartTime": "2018-07-02 01:04:30",
        "EndTime": "2018-07-02 01:04:30",
        "Size": 192,
        "Strategy": 0,
        "Status": 1,
        "DBs": [
        "InternalAddr": "",
        "ExternalAddr": ""

5. Developer Resources

API Explorer

This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InternalError.DBError Database error.
InternalError.GcsError GCS API error.
InternalError.SystemError System error.
InternalError.UnknownError Unknown error.
InvalidParameter Incorrect parameter.
InvalidParameter.InputIllegal Invalid input.
InvalidParameter.ParamsAssertFailed Parameter assertion conversion error.
ResourceNotFound.InstanceNotFound The instance does not exist.