ModifySnapshotsAttribute

1. API Description

This API is used to modify the attributes of the specified snapshot.

Note

• Batch operations are supported. The maximum number of snapshots in each request is 100.

• If any of the snapshot IDs does not exist, the operation will fail immediately.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
snapshotIds	Yes	Array of String	List of snapshot IDs.
snapshotName	No	String	Snapshot name.
retentionTime	No	String	Snapshot expiration time. Format: yyyy-MM-ddTHH:mm:ssZ. If you want to change it to indefinite retention, please set isPermanent = true. If you set the custom retention, it must be set to 24 hours after the current time.
isPermanent	No	Boolean	Whether the snapshots created by the snapshot schedule are retained indefinitely.

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

示例

Modify the attributes of the specified snapshot. Modify the name and set the retention time to indefinite.

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

Request：
{
    "snapshotIds": ["snapshotId1","snapshotId2"],
    "snapshotName": "snap_201711301143",
    "isPermanent": true
}

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_DISK_SNAPSHOT_NOT_FOUND	The snapshot does not exist.