Modifies the name, description, or retention period of a snapshot.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
SnapshotId | string | Yes | The ID of the snapshot. | s-bp199lyny9bb47pa**** |
SnapshotName | string | No | 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 (-). The name cannot start with auto because snapshots whose names start with auto are recognized as automatic snapshots. | testSnapshotName |
Description | string | No | The description of the snapshot. The description must be 2 to 256 characters in length and cannot start with http:// or https://. | testDescription |
DisableInstantAccess | boolean | No | Specifies whether to disable the instant access feature. Valid values:
Default value: false. | false |
RetentionDays | integer | No | The retention period of the snapshot. 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.
| 10 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidSnapshotName.Malformed | The specified SnapshotName is wrongly formed. | The format of the specified snapshot name is invalid. |
400 | NoAttributeToModify | No attribute to be modified in this request. | No attributes are modified. |
400 | InvalidRetentionDays.Malformed | The specified RetentionDays is not valid. | The specified RetentionDays parameter is invalid. |
400 | InvalidOperation.DecreaseRetentionDaysUnsupported | The requested operation to decrease retention days for the snapshot is not supported. | - |
400 | InvalidSnapshotId.NotReady | The specified snapshot has not completed yet. | The specified snapshot is being created. |
401 | IncorrectDiskStatus.CreatingSnapshot | The snapshot of the disk is still creating. | Another snapshot is being created for the disk. Wait until the snapshot is created and try again. |
404 | InvalidDescription.Malformed | The specified description is wrongly formed. | The resource description is invalid. 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 ID does not exist. |
404 | InvalidSnapshotDisableInstantAccess.Malformed | The specified DisableInstantAccess is not valid! | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-10-16 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2023-09-18 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||
|