DescribeBaseBackups

PDF

Focus Mode

Font Size

Last updated: 2026-04-13 13:05:24

1. API Description

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

This API is used to query the list of data backups.

A maximum of 1000 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: DescribeBaseBackups.
Version	Yes	String	Common Params. The value used for this API: 2017-03-12.
Region	No	String	Common Params. This parameter is not required for this API.
MinFinishTime	No	String	Minimum end time of a backup in the format of `2018-01-01 00:00:00`. It is 7 days ago by default.
MaxFinishTime	No	String	Maximum end time of a backup in the format of `2018-01-01 00:00:00`. It is the current time by default.
Filters.N	No	Array of Filter	Query using one or more filter criteria. filter criteria currently supported include:. db-instance-id: filter by instance id (string type). db-instance-name: specifies the instance name to filter by, supports fuzzy matching (string type). db-instance-ip: specifies the instance VPC ip for filtering (string type). base-backup-id: filter by backup set id (in string format). db-instance-status: filter by instance status (in string format). valid values refer to the DBInstanceStatus field in the DBInstance structure (https://www.tencentcloud.com/document/product/409/16778#dbinstance).
Limit	No	Integer	The maximum number of results returned per page. Value range: 1-100. Default: `10`
Offset	No	Integer	Data offset, which starts from 0.
OrderBy	No	String	Specifies the sorting field, supports StartTime, FinishTime, and Size. default value: StartTime.
OrderByType	No	String	Sorting method, including ascending: `asc` and descending: `desc`. the default value is `desc`.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of queried data backups.
BaseBackupSet	Array of BaseBackup	Detailed data backup information 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 List of Data Backups

This example shows you how to query the latest data backup set record.

Input Example

POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBaseBackups
<Common request parameters>

{
    "Limit": 1,
    "Offset": 0,
    "OrderBy": "FinishTime",
    "OrderByType": "desc"
}

Output Example

{
    "Response": {
        "BaseBackupSet": [
            {
                "BackupMethod": "physical",
                "BackupMode": "manual",
                "DBInstanceId": "postgres-9n26zs6n",
                "ExpireTime": "2023-02-18 23:59:59",
                "FinishTime": "2023-02-15 19:09:36",
                "Id": "88d3a71e-b822-5728-9d41-d8cfc0d0556e",
                "Name": "manual-20230215190924.tar.gz",
                "Size": 39845888,
                "StartTime": "2023-02-15 19:09:24",
                "State": "finished"
            }
        ],
        "RequestId": "3f164712-8746-464f-a490-3084a470000e",
        "TotalCount": 10
    }
}

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.DatabaseAccessError	Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FailedOperationError	Operation failed. Please try again later.
InvalidParameterValue.InvalidParameterValueError	Incorrect parameter value
OperationDenied.CamDeniedError	This operation cannot be performed.

Help and Support

Was this page helpful?

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

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

TencentDB for PostgreSQL