Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to set the configuration for an automatic backup.
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: ModifyAutoBackupConfig. |
| Version | Yes | String | Common Params. The value used for this API: 2018-04-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Specifies the instance ID. Example: crs-xjhsdj****. Log in to the Redis console and copy the instance ID in the instance list. |
| WeekDays.N | No | Array of String | Set the automatic backup cycle. It can be set to Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday. This parameter cannot be modified for the moment. |
| TimePeriod | No | String | Backup time period. It can be set to every full hour. Format: 00:00-01:00, 01:00-02:00...... 23:00-00:00. |
| AutoBackupType | No | Integer | Automatic backup type. Currently, it can only be configured as: 1, scheduled backup. |
| BackupStorageDays | No | Integer | Number of days to save full backup files. Only support setting to 7, unit: days. For a longer period, please submit a ticket to apply. |
| Parameter Name | Type | Description |
|---|---|---|
| AutoBackupType | Integer | Automatic backup type. Currently, it can only be configured as: 1, scheduled backup. |
| WeekDays | Array of String | Automatic backup cycle. Value: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. |
| TimePeriod | String | Automatic scheduled backup time period. Format: 00:00-01:00, 01:00-02:00...... 23:00-00:00. |
| BackupStorageDays | Integer | Number of days to save full backup files, in days. |
| 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 configure automatic backup rules.
POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAutoBackupConfig
<Common request parameters>
{
"InstanceId": "crs-5a4py64p",
"AutoBackupType": 1,
"TimePeriod": "01:00-02:00",
"WeekDays": [
"Wednesday"
]
}{
"Response": {
"BackupStorageDays": 7,
"AutoBackupType": 1,
"WeekDays": [
"Wednesday"
],
"RequestId": "65e950b9-78e8-49b1-9200-0e62a1925554",
"TimePeriod": "00:00-01:00"
}
}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.Unknown | Invalid data is entered for weekday. |
| InternalError.InternalError | Internal error. |
| InvalidParameter.InvalidParameter | Invalid service parameter. |
| InvalidParameter.NotSupported | The operation is unsupported due to incorrect parameters. |
| InvalidParameter.Period | The time format or time range is invalid. |
| InvalidParameter.PermissionDenied | The API has no CAM permissions. |
| InvalidParameterValue.WeekDaysIsInvalid | Invalid data is entered for weekday. |
| ResourceNotFound.InstanceNotExists | No Redis instance is found by the serialId. |
| UnauthorizedOperation.NoCAMAuthed | No CAM permissions. |
피드백