1. API Description
Domain name for API request: postgres.tencentcloudapi.com.
This API is used to query all backup plans of an instance.
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.
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: DescribeBackupPlans. |
| 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. |
| DBInstanceId |
Yes |
String |
Instance ID |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Plans |
Array of BackupPlan |
The set of instance backup plans |
| 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 all backup plans of instance
This example shows you how to query all backup plans of instance "postgres-xxxxxxxx".
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupPlans
<Common request parameters>
{
"DBInstanceId": "postgres-xxxxxxxx"
}
Output Example
{
"Response": {
"Plans": [
{
"BackupPeriod": "[\"monday\",\"thursday\",\"friday\"]",
"BaseBackupRetentionPeriod": 3,
"MaxBackupStartTime": "10:00:00",
"MinBackupStartTime": "08:00:00"
}
],
"RequestId": ""
}
}
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.CamCheckResourceError |
Failed to get permissions. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.CamSigAndAuthError |
Authentication failed. Please try again later. If the problem persists, please contact customer service. |
| 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. |
| InternalError.InternalHttpServerError |
An exception occurred while executing the request. |
| InvalidParameterValue.InvalidParameterValueError |
Incorrect parameter value |
| OperationDenied.CamDeniedError |
This operation cannot be performed. |
| OperationDenied.InstanceAccessDeniedError |
You do not have the permission to operate this resource. |
| OperationDenied.InstanceStatusLimitOpError |
This operation cannot be performed on an instance in this status. |
| ResourceNotFound.InstanceNotFoundError |
The instance does not exist. |