Last updated: 2020-12-01 20:30:29

1. API Description

Domain name for API request:

This API is used to query the instance backup list.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example:

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 parameter. The value used for this API: DescribeDBBackups.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
DBInstanceId Yes String Instance ID in the format of postgres-4wdeb0zv.
Type Yes Integer Backup mode (1: full). Currently, only full backup is supported. The value is 1.
StartTime Yes Timestamp Query start time in the format of 2018-06-10 17:06:38, which cannot be more than 7 days ago
EndTime Yes Timestamp Query end time in the format of 2018-06-10 17:06:38
Limit No Integer Number of entries to be returned per page for backup list. Default value: 20. Minimum value: 1. Maximum value: 100. (If this parameter is left empty or 0, the default value will be used)
Offset No Integer Page number for data return in paged query. Pagination starts from 0. Default value: 0.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of backup files in the returned backup list
BackupList Array of DBBackup Backup list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the backup list of the "postgres-6fego161" instance

Input Example
&StartTime=2018-06-10 17:06:38
&EndTime=2018-06-11 17:06:38
&<Common request parameters>

Output Example

  "Response": {
    "TotalCount": 2,
    "BackupList": [
        "Status": 2,
        "InternalAddr": "",
        "StartTime": "2018-06-22 01:56:01.181971",
        "ExternalAddr": "",
        "Strategy": 1,
        "DbList": null,
        "Way": 1,
        "EndTime": "2018-06-22 01:56:55.071181",
        "Type": 1,
        "Id": 450,
        "Size": 3654968
        "Status": 2,
        "InternalAddr": "",
        "StartTime": "2018-06-21 01:55:04.199169",
        "ExternalAddr": "",
        "Strategy": 1,
        "DbList": null,
        "Way": 1,
        "EndTime": "2018-06-21 01:55:58.477232",
        "Type": 1,
        "Id": 450,
        "Size": 3654991
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"

5. Developer Resources


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.UnauthorizedOperation Authentication failed.
FailedOperation.OssOperationFailed Failed to request the backend API.
InternalError.DBError Backend database execution error.
InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
InvalidParameterValue.IllegalRegion Invalid Region parameter.
InvalidParameterValue.InstanceNotExist The current instance does not exist.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback