ModifySnapshotAttribute-阿里云帮助中心

Modifies the name, description, or retention period of a snapshot.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:ModifySnapshotAttribute

update

*Snapshot

acs:ecs:{#regionId}:{#accountId}:snapshot/{#snapshotId}

None

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 snapshot description. It can be empty or up to 256 characters in length. It cannot start with http:// or https://.	testDescription
DisableInstantAccess	boolean	No	Specifies whether to disable the instant access feature. Valid values: true false Default value: false. Note This parameter is no longer used. By default, new standard snapshots of Enterprise SSDs (ESSDs) are upgraded to instant access snapshots free of charge without the need for additional configurations. For more information, see Use the instant access feature.	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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

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.
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.
400	IncorrectDiskStatus.CreatingSnapshot	A previous snapshot creation is in process.	A previous snapshot creation task is in process. Please try again later.
403	InvalidOperation.ResourceManagedByCloudProduct	The current operation is not supported because the resource is managed by a cloud product. Please contact the relevant cloud product to confirm the reason.	This operation is not supported because the resource is managed by cloud products. Contact the corresponding cloud product to confirm the reason.
403	InvalidOperation.DefaultFreeSnapshotNotSupport	The specified snapshot is a default free snapshot and does not support this operation.	The specified snapshot is a default free snapshot and does not support the current operation.
404	InvalidDescription.Malformed	The specified description is wrongly formed.
404	InvalidSnapshotId.NotFound	The specified SnapshotId does not exist.
404	InvalidSnapshotDisableInstantAccess.Malformed	The specified DisableInstantAccess is not valid!

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.