Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to modify the backup plan of an instance, such as modifying the backup start time. By default, a full backup starts at midnight every day and the generated backup files will be retained for seven days.
A maximum of 100 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: ModifyBackupPlan. |
| 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. obtain through the api DescribeDBInstances. |
| MinBackupStartTime | No | String | The earliest time to start a backup |
| MaxBackupStartTime | No | String | The latest time to start a backup |
| BaseBackupRetentionPeriod | No | Integer | Backup retention period in days. Value range: 7-1830 |
| BackupPeriod.N | No | Array of String | Instance backup period. if by week, format is lowercase english word of week and set at least two days for backup. if by month, format is digits such as ["1","2"]. |
| LogBackupRetentionPeriod | No | Integer | Instance log backup retention duration, with a value range of 7-1830 and a unit of day |
| PlanId | No | String | Backup plan ID. specifies which backup plan to modify. if left empty, the default backup plan will be modified. |
| PlanName | No | String | Specifies the name of the backup plan to modify. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
This example shows you how to modify the backup plan of the postgres-xxxxxxxx instance to every Monday and Tuesday from 01:00:00 to 02:00:00, with a backup retention period of 7 days.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBackupPlan
<Common request parameters>
{
"BackupPeriod": [
"tuesday",
"monday"
],
"BaseBackupRetentionPeriod": 7,
"DBInstanceId": "postgres-xxxxxxxx",
"MinBackupStartTime": "01:00:00",
"MaxBackupStartTime": "02:00:00"
}
{
"Response": {
"RequestId": "8a61e500-aa33-454c-9ec2-da2a368c39ab"
}
}
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.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. |
| InvalidParameter.ParameterCheckError | Failed to check the parameter. |
| InvalidParameterValue.InvalidParameterValueError | Incorrect parameter value |
| OperationDenied.CamDeniedError | This operation cannot be performed. |
| OperationDenied.InstanceStatusLimitOpError | This operation cannot be performed on an instance in this status. |
| ResourceNotFound.InstanceNotFoundError | The instance does not exist. |
피드백