Domain name for API request: postgres.tencentcloudapi.com.
This API is used to query all backup plans of an instance.
A maximum of 20 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: DescribeBackupPlans. |
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. |
DBInstanceId | Yes | String | Instance ID |
Parameter Name | Type | Description |
---|---|---|
Plans | Array of BackupPlan | The set of instance backup plans |
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 all backup plans of the "postgres-xxxxxxxx" instance.
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupPlans
<Common request parameters>
{
"DBInstanceId": "postgres-xxxxxxxx"
}
{
"Response": {
"Plans": [
{
"BackupPeriod": "[\"monday\",\"thursday\",\"friday\"]",
"BaseBackupRetentionPeriod": 3,
"MaxBackupStartTime": "10:00:00",
"MinBackupStartTime": "08:00:00"
}
],
"RequestId": ""
}
}
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.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. |
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. |
Was this page helpful?