Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to query the backup statistics of an instance. It will return the number and size (bytes) of backups of the instance.
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: DescribeBackupSummaries. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| 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. |
| 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). |
| OrderBy | No | String | Sorting field, supports TotalBackupSize - total size of backups, LogBackupSize - size of backup logs, ManualBaseBackupSize - size of manual backup data, AutoBaseBackupSize - size of automatic data backup. if this parameter is not input, no sorting is performed by default. |
| OrderByType | No | String | Sorting method, including ascending: asc and descending: desc. the default value is asc. |
| Parameter Name | Type | Description |
|---|---|---|
| BackupSummarySet | Array of BackupSummary | Backup statistics list. |
| TotalCount | Integer | Number of all queried backups. |
| 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. |
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupSummaries
<Common request parameters>
{
"Limit": 1,
"Offset": 0,
"OrderByType": "desc"
}
{
"Response": {
"BackupSummarySet": [
{
"AutoBaseBackupCount": 3,
"AutoBaseBackupSize": 3535342436352,
"DBInstanceId": "postgres-lsw5y0bp",
"LogBackupCount": 2,
"LogBackupSize": 167792640,
"ManualBaseBackupCount": 1,
"ManualBaseBackupSize": 1178447478784,
"TotalBackupCount": 6,
"TotalBackupSize": 4713957707776
}
],
"RequestId": "3929dd3a-d95d-4ec2-ae69-a98317ce24fa",
"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.DatabaseAffectedError | Data operation failed. Please contact customer service. |
| FailedOperation.FailedOperationError | Operation failed. Please try again later. |
| InvalidParameterValue.InvalidParameterValueError | Incorrect parameter value |
| OperationDenied.CamDeniedError | This operation cannot be performed. |
| ResourceNotFound.InstanceNotFoundError | The instance does not exist. |
피드백