ApplyAutoSnapshotPolicy

1. API Description

This API is used to attach a disk to the specified snapshot schedule.

Note

• If the disk is already attached to this snapshot schedule, repeated operations will not return an error. If the disk is already attached to another snapshot schedule, the error INVALID_DISK_AUTO_SNAPSHOT_POLICY_EXIST will be reported. And the operation will fail immediately.

• If the attached disk is in unavailable state when the snapshot schedule is executed, the snapshot will not be created automatically.

• A disk can only be attached to one snapshot schedule.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
autoSnapshotPolicyId	Yes	String	Snapshot schedule ID.
diskIds	Yes	Array of String	ID list of disks to be attached.

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. Code Example

示例

Attach disks to the snapshot schedule.

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

Request：
{
  "autoSnapshotPolicyId": "<autoSnapshotPolicyId>",
  "diskIds": [
    "<diskId>"
  ]
}

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.

HTTP Status Code	Error Code	Description
404	INVALID_AUTO_SNAPSHOT_POLICY_NOT_FOUND	The snapshot schedule does not exist.
404	INVALID_AUTO_SNAPSHOT_ZONE_MISMATCH	The disk is attached to another snapshot schedule.
404	INVALID_DISK_AUTO_SNAPSHOT_POLICY_EXIST	The disk is attached to another snapshot schedule.
404	INVALID_DISK_NOT_FOUND	The disk does not exist.
400	INVALID_SYSTEM_DISK_NOT_SUPPORT	Operations on boot disks are not supported.