Disables instant access for a snapshot or modifies the name, description, or retention period of the snapshot.
Debugging
Request parameters
Parameter |
Type |
Required |
Example |
Description |
Action | String | Yes | ModifySnapshotAttribute | The operation that you want to perform. Set the value to ModifySnapshotAttribute. |
SnapshotId | String | Yes | s-bp199lyny9bb47pa**** | The ID of the snapshot. |
SnapshotName | String | No | testSnapshotName | The name of the snapshot. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-). It cannot start with auto because snapshots whose names start with auto are recognized as automatic snapshots. |
Description | String | No | testDescription | The description of the snapshot. The description must be 2 to 256 characters in length and cannot start with http:// or https://. |
DisableInstantAccess | Boolean | No | false | Specifies whether to disable the instant access feature. Valid values:
Default value: false. |
RetentionDays | Integer | No | 10 | The retention period of the snapshot. Unit: days. After you specify this parameter, the end time of the new retention period is the specified number of days apart from the creation time of the snapshot, which follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC. Valid values: 1 to 65536. Note You can extend the retention period of the snapshot and cannot shorten the retention period. |
Response parameters
Parameter |
Type |
Example |
Description |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E | The ID of the request. |
Examples
Sample requests
https://ecs.aliyuncs.com/?Action=ModifySnapshotAttribute
&SnapshotId=s-bp199lyny9bb47pa****
&SnapshotName=testSnapshotName
&Description=testDescription
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifySnapshotAttributeResponse>
<RequestId>C8B26B44-0189-443E-9816-D951F59623A9</RequestId>
</ModifySnapshotAttributeResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "C8B26B44-0189-443E-9816-D951F59623A9"
}
Error codes
HTTP status code |
Error code |
Error message |
Description |
400 | InvalidSnapshotName.Malformed | The specified SnapshotName is wrongly formed. | Invalid SnapshotName value. |
400 | NoAttributeToModify | No attribute to be modified in this request. | No attributes of the snapshot are modified. |
400 | InvalidRetentionDays.Malformed | The specified RetentionDays is not valid. | Invalid RetentionDays value. |
400 | InvalidOperation.DecreaseRetentionDaysUnsupported | The requested operation to decrease retention days for the snapshot is not supported. | You cannot shorten the retention period of the snapshot. |
400 | InvalidSnapshotId.NotReady | The specified snapshot has not completed yet. | The specified snapshot is being created. |
404 | InvalidDescription.Malformed | The specified description is wrongly formed. | Invalid Description value. The description must be 2 to 256 characters in length and cannot start with http:// or https://. |
404 | InvalidSnapshotId.NotFound | The specified SnapshotId does not exist. | The specified snapshot is not found. Check whether the snapshot ID is correct. |
For a list of error codes, see Service error codes.