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

Queries snapshot chains of disks. A snapshot chain consists of all snapshots of a disk. Each disk corresponds to one snapshot chain.

Operation description

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

The request parameters such as RegionId, DiskIds, and InstanceId act as filters. Logical AND is used between these parameters.
If you do not specify any parameters, the filters do not take effect. If DiskIds and SnapshotLinkIds are both empty arrays, the filters are considered valid, but the response is empty.

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 DescribeRegions to query the most recent region list.	cn-hangzhou
InstanceId	string	No	The instance ID.	i-bp1h6jmbefj2cyqs****
DiskIds	string	No	The IDs of disks. You can specify up to 100 disk IDs at a time. The DiskIds parameter is a JSON array. Separate multiple IDs with commas (,).	["d-bp1d6tsvznfghy7y**", "d-bp1ippxbaql9zet7", … "d-bp1ib7bcz07lcxa9**"]
SnapshotLinkIds	string	No	The IDs of snapshot chains. You can specify up to 100 snapshot chain IDs at a time. The SnapshotLinkIds parameter is a JSON array. Separate multiple IDs with commas (,).	["sl-bp1grgphbcc9brb5**", "sl-bp1c4izumvq0i5bs", … "sl-bp1akk7isz866dds**"]
PageNumber	integer	No	The page number of the disk status list. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Valid values: 1 to 100. Default value: 10.	50
NextToken	string	No	The pagination token. Set this parameter to the NextToken value returned in the previous API call.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	The maximum number of entries per page for a paged query. Maximum value: 100. Default value: If this parameter is not specified or is set to a value less than 10, the default value is 10. If this parameter is set to a value greater than 100, the default value is 100.	10

Response elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token returned in this call.	caeba0bbb2be03f84eb48b699f0a****
PageSize	integer	The number of entries per page as specified in the request.	50
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number of the snapshot chain list.	1
TotalCount	integer	The total number of snapshot chains. Note When you use the `MaxResults` and `NextToken` parameters for a paged query, the returned `TotalCount` value is invalid. For paging, use `MaxResults` and `NextToken` instead.	9
SnapshotLinks	object
SnapshotLink	array<object>	The collection of snapshot chain information.
	object
InstantAccess	boolean	Indicates whether the instant access feature is enabled. Valid values: true: The instant access feature is enabled. The feature can be enabled only for Enterprise SSDs (ESSDs). false: The instant access feature is disabled. The snapshot is a standard snapshot for which the instant access feature is disabled. Note This parameter is no longer used. By default, standard snapshots of 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
TotalSize	integer	The total size of all snapshots in the snapshot chain. Unit: byte.	2097152
SourceDiskName	string	The name of the source disk.	testSourceDiskName
SourceDiskSize	integer	The capacity of the source disk. Unit: GiB.	40
SourceDiskType	string	The type of the source disk. Valid values: system: system disk data: data disk	data
InstanceId	string	The ID of the instance.	i-bp1h6jmbefj2cyqs****
SnapshotLinkId	string	The ID of the snapshot chain.	sl-2ze0y1jwzpb1geqx****
TotalCount	integer	The total number of snapshots.	1
RegionId	string	The region ID of the source disk.	cn-hangzhou
SourceDiskId	string	The ID of the source disk. This parameter is retained even if the source disk is deleted.	d-bp1d6tsvznfghy7y****
InstanceName	string	The name of the instance.	testInstanceName
Category	string	The type of the snapshot chain. Valid values: standard: standard snapshot chain. archive: archive snapshot chain. flash: instant access snapshot chain.	standard

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidInstanceId.NotFound	The specified instanceId is not exists.
400	InvalidRegionId	The specified regionId is invalid.	The specified RegionId parameter is invalid.
400	InvalidSnapshotLinkIds	The specified snapshotLinkIds is invalid.	The specified SnapshotLinkId parameter is invalid.
400	InvalidDiskIds	The specified diskIds is invalid.	The specified DiskIds parameter is invalid.
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.