tencent cloud

Feedback

ModifyBackupPlan

Last updated: 2022-07-08 10:18:52

1. API Description

Domain name for API request: postgres.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 20 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: 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
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: 3-7
BackupPeriod.N No Array of String Backup cycle, which means on which days each week the instance will be backed up. The parameter value should be the lowercase names of the days of the week.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the backup plan of instance

This example shows you how to modify the backup plan of instance "postgres-xxxxxxxx". According to the new backup plan, the instance will be backed up during 01:00:00–02:00:00 AM and the backup files will be retained for three days.

Input Example

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

{
    "BackupPeriod": [
        "tuesday",
        "monday"
    ],
    "BaseBackupRetentionPeriod": "3",
    "DBInstanceId": "postgres-xxxxxxxx",
    "MinBackupStartTime": "01:00:00",
    "MaxBackupStartTime": "02:00:00"
}

Output Example

{
  "Response": {
    "RequestId": "8a61e500-aa33-454c-9ec2-da2a368c39ab"
  }
}

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.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.
Contact Us

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

Technical Support

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

7x24 Phone Support