Domain name for API request: postgres.tencentcloudapi.com.
This API is used to query the backup overview. It will return the current number and size of backups, free backup space size, and paid backup space size (all size values are in bytes).
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: DescribeBackupOverview. |
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. |
Parameter Name | Type | Description |
---|---|---|
TotalFreeSize | Integer | Total free space size in bytes |
UsedFreeSize | Integer | Used free space size in bytes |
UsedBillingSize | Integer | Used paid space size in bytes |
LogBackupCount | Integer | Number of log backups |
LogBackupSize | Integer | Log backup size in bytes |
ManualBaseBackupCount | Integer | Number of manually created full backups |
ManualBaseBackupSize | Integer | Size of manually created full backups in bytes |
AutoBaseBackupCount | Integer | Number of automatically created full backups |
AutoBaseBackupSize | Integer | Size of automatically created full backups in bytes |
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.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupOverview
<Common request parameters>
{}
{
"Response": {
"AutoBaseBackupCount": 494,
"AutoBaseBackupSize": 25577154048,
"LogBackupCount": 4677,
"LogBackupSize": 89789143040,
"ManualBaseBackupCount": 20,
"ManualBaseBackupSize": 1002476032,
"RequestId": "b4c5f18a-f917-46b4-8689-d4a64e3381fb",
"TotalFreeSize": 13378823127040,
"UsedBillingSize": 4329912320,
"UsedFreeSize": 112038860800
}
}
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. |
Was this page helpful?