All Products
Search
Document Center

Elastic Compute Service:ModifySnapshotAttribute

Last Updated:Feb 04, 2024

Modifies the name or description of a snapshot or disables the instant access feature.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SnapshotIdstringYes

The ID of the snapshot.

s-bp199lyny9bb47pa****
SnapshotNamestringNo

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
DescriptionstringNo

The description of the snapshot. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

testDescription
DisableInstantAccessbooleanNo

Specifies whether to disable the instant access feature. Valid values:

  • true
  • false

Default value: false.

false
RetentionDaysintegerNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidSnapshotName.MalformedThe specified SnapshotName is wrongly formed.The format of the specified snapshot name is invalid.
400NoAttributeToModifyNo attribute to be modified in this request.No attributes are modified.
400InvalidRetentionDays.MalformedThe specified RetentionDays is not valid.The specified RetentionDays parameter is invalid.
400InvalidOperation.DecreaseRetentionDaysUnsupportedThe requested operation to decrease retention days for the snapshot is not supported.-
400InvalidSnapshotId.NotReadyThe specified snapshot has not completed yet.The specified snapshot is being created.
401IncorrectDiskStatus.CreatingSnapshotThe snapshot of the disk is still creating.Another snapshot is being created for the disk. Wait until the snapshot is created and try again.
404InvalidDescription.MalformedThe 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://.
404InvalidSnapshotId.NotFoundThe specified SnapshotId does not exist.The specified snapshot ID does not exist.
404InvalidSnapshotDisableInstantAccess.MalformedThe specified DisableInstantAccess is not valid!-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-10-16The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
    Added Error Codes: 401
2023-09-18The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: RetentionDays