CreateAutoSnapshotPolicy

1. API Description

This API is used to create a snapshot schedule.

Note

• The time of the snapshot schedule is UTC+0.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
zoneId	Yes	String	Availability zone ID.
autoSnapshotPolicyName	Yes	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	Yes	Array of Integer	The backup date of the schedule. Unit: day, cycle: week (e.g., 1 = Monday) Available range: [1, 7].
hours	Yes	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. The default is indefinite. Value range: -1 or [1,65535].
resourceGroupId	No	String	Resource group ID.

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.
autoSnapshotPolicyId	String	The ID of the snapshot schedule.

4. Code Example

示例

Create a snapshot schedule. The schedule is executed every Wednesday at 00:00. Retention time is 10 days.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: CreateAutoSnapshotPolicy
<Common Request Params>

Request：
{
  "zoneId": "asia-east-1a",
  "autoSnapshotPolicyName": "week3-policy",
  "repeatWeekDays": [
    3
  ],
  "hours": [
    0
  ],
  "retentionDays": 10
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "autoSnapshotPolicyId": "<autoSnapshotPolicyId>"
  }
}

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.

HTTP Status Code	Error Code	Description
400	INVALID_RETENTION_DAYS	Invalid retention days.
400	INVALID_SNAPSHOT_REGION_NOT_SUPPORT	Snapshots are not supported in the region.
404	INVALID_ZONE_NOT_FOUND	The availability zone does not exist.