Domain name for API request: postgres.tencentcloudapi.com.
This API is used to query the list of full backups.
A maximum of 1000 requests can be initiated per second for this API.
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 | Filter instances by using one or more filters. Valid values: db-instance-idFilter (filter by instance ID in string), db-instance-name (filter by instance name in string), db-instance-ip (filter by instance VPC IP address in string), base-backup-id (filter by backup set ID in string), |
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 | Sorting field. Valid values: StartTime , FinishTime , Size . |
OrderByType | No | String | Sorting order. Valid values: asc (ascending), desc (descending). |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of queried full backups |
BaseBackupSet | Array of BaseBackup | List of full backup details |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query the latest backup set record.
POST / HTTP/1.1Host: postgres.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeBaseBackups<common request parameters>{ "Limit": 1, "Offset": 0, "OrderBy": "FinishTime", "OrderByType": "desc"}
{
"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
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
本页内容是否解决了您的问题?