tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for PostgreSQLBackup and Recovery APIsDescribeBackupOverview
DescribeBackupOverview
Last updated: 2024-06-17 14:26:37
DescribeBackupOverview
Last updated: 2024-06-17 14:26:37

1. API Description

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.

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: 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.

3. Output Parameters

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.

4. Example

Example1 Querying the backup overview

Input Example

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

{}

Output Example

{
    "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
    }
}

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

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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support