Use DescribeSnapshotLinks to query cloud disk snapshot chains - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the snapshot chains of disks. A snapshot chain consists of all snapshots of a disk. Each disk has one snapshot chain.

Operation description

When you call this operation, take note of the following items:

Request parameters such as RegionId, DiskIds, and InstanceId act as filters. The logical AND operator is applied between these parameters.
If you do not specify any parameters, the filters do not take effect. If both DiskIds and SnapshotLinkIds are set to empty arrays, the filters are considered valid, but an empty result is returned.

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:DescribeSnapshotLinks

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the disk. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
InstanceId	string	No	The instance ID.	i-bp1h6jmbefj2cyqs****
DiskIds	string	No	The disk IDs. You can specify up to 100 disk IDs at a time. Set the value of DiskIds to a JSON array. Separate multiple IDs with commas (,).	["d-bp1d6tsvznfghy7y**", "d-bp1ippxbaql9zet7", … "d-bp1ib7bcz07lcxa9**"]
SnapshotLinkIds	string	No	The snapshot chain IDs. You can specify up to 100 snapshot chain IDs at a time. Set the value of SnapshotLinkIds to a JSON array. Separate multiple IDs with commas (,).	["sl-bp1grgphbcc9brb5**", "sl-bp1c4izumvq0i5bs", … "sl-bp1akk7isz866dds**"]
PageNumber	integer	No	The page number of the snapshot chain list. Pages start from 1. Default value: 1.	1
PageSize	integer	No	The paging Settings for the number of entries per page in a paged query. Valid values: 1 to 100. Default value: 10.	50
NextToken	string	No	The pagination token. Set the value to the NextToken value returned from the last API call.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	The paging Settings for the maximum number of entries per page in a paged query. Maximum value: 100. Default value: If you do not specify a value or the Settings value is less than 10, the default value is 10. If the Settings value is greater than 100, the default value is 100.	10

Response elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token returned by the current call.	caeba0bbb2be03f84eb48b699f0a****
PageNumber	integer	The page number of the snapshot chain list.	1
PageSize	integer	The number of entries per page.	50
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
SnapshotLinks	object
SnapshotLink	array<object>	The collection of snapshot chain information.
	object
Category	string	The snapshot chain type. Valid values: standard: standard snapshot chain. archive: archive snapshot chain. flash: instant access snapshot chain.	standard
InstanceId	string	The instance ID.	i-bp1h6jmbefj2cyqs****
InstanceName	string	Instance name	testInstanceName
InstantAccess	boolean	Indicates whether the snapshot instant access feature is active. Valid values: true: Active. Only enterprise SSD disks support this feature. false: Shutdown. The snapshot is a standard SSD snapshot for which the snapshot instant access feature is not active. Note This parameter is deprecated. Standard snapshots of enterprise SSD disks are upgraded to instant access by default. You do not need to perform additional configurations, and no additional fees are incurred.	false
RegionId	string	The region ID of the source disk of the snapshot chain.	cn-hangzhou
SnapshotLinkId	string	The snapshot chain ID.	sl-2ze0y1jwzpb1geqx****
SourceDiskId	string	The source disk ID. If the source disk of the snapshot is deleted, this field is still retained.	d-bp1d6tsvznfghy7y****
SourceDiskName	string	The name of the source disk.	testSourceDiskName
SourceDiskSize	integer	The capacity of the source disk. Unit: GiB.	40
SourceDiskType	string	The disk type of the source disk. Valid values: system: system disk. data: data disk.	data
TotalCount	integer	The total number of snapshots.	1
TotalSize	integer	The total size of all snapshots in the snapshot chain. Unit: bytes.	2097152
TotalCount	integer	The total number of snapshot chains. Note When you use the `MaxResults` and `NextToken` parameters for paging in a paged query, the returned `TotalCount` value is invalid.	9

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "PageNumber": 1,
  "PageSize": 50,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "SnapshotLinks": {
    "SnapshotLink": [
      {
        "Category": "standard",
        "InstanceId": "i-bp1h6jmbefj2cyqs****",
        "InstanceName": "testInstanceName",
        "InstantAccess": false,
        "RegionId": "cn-hangzhou",
        "SnapshotLinkId": "sl-2ze0y1jwzpb1geqx****",
        "SourceDiskId": "d-bp1d6tsvznfghy7y****",
        "SourceDiskName": "testSourceDiskName",
        "SourceDiskSize": 40,
        "SourceDiskType": "data",
        "TotalCount": 1,
        "TotalSize": 2097152
      }
    ]
  },
  "TotalCount": 9
}

Error codes

HTTP status code	Error code	Error message
400	InvalidInstanceId.NotFound	The specified InstanceId does not exist. Please verify the instance ID and the current region.
400	InvalidRegionId	The specified parameter RegionId is not valid. Please call DescribeRegions to query the supported regions.
400	InvalidSnapshotLinkIds	The specified parameter SnapshotLinkIds is not valid. Ensure the value is a valid list of snapshot link IDs.
400	InvalidDiskIds	The specified parameter DiskIds is not valid. Ensure the value is a valid list of disk IDs.
500	InternalError	The request processing has failed due to an internal error and you may retry later or contact support with the request ID.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.