ModifyAutoSnapshotPolicy
1. API Description
This API is used to modify the basic information of the snapshot schedule.
2. Input Parameters
The following request parameter list only provides API request parameters.
autoSnapshotPolicyId
Yes
String
The ID of the snapshot schedule.
autoSnapshotPolicyName
No
String
The name of the snapshot schedule.
The length is 2 to 63 characters.
Only letters, numbers, -/_ and periods (.) are supported.
The name must start and end with a number or a letter.
repeatWeekDays
No
Array of Integer
The backup date of the schedule.
Unit: day, cycle: week (e.g., 1 = Monday)
Available range: [1, 7].
hours
No
Array of Integer
Specify the start time of the snapshot schedule.
UTC time is used. Unit: hour.
24 time points are available from 00:00 to 23:00, 1 = 01:00, and so on.
Available range: [0, 23].
retentionDays
No
Integer
Retention time of automatic snapshots. Unit: day.
If the value is set to -1, it means that it is retained indefinitely.
Value range: -1 or [1,65535].
3. Output Parameters
requestId
String
The unique request ID,
which is returned for each request. RequestId is required for locating a problem.
4. Code Example
Modify the attributes of the snapshot schedule, including the name, and set the retention time to 3 days.
POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyAutoSnapshotPolicy
<Common Request Params>
Request:
{
"autoSnapshotPolicyId": "<autoSnapshotPolicyId>",
"autoSnapshotPolicyName": "Test",
"retentionDays": 3
}
Response:
{
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"response": {
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
}
}
5. Developer Resources
Zenlayer Cloud API 2.0 SDKs to make it easier for you to call APIs. More programming languages will be supported.
6. Error Codes
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
404
INVALID_AUTO_SNAPSHOT_POLICY_NOT_FOUND
The snapshot schedule does not exist.
400
INVALID_RETENTION_DAYS
Invalid retention days.
Last updated