DescribeSnapshotLinks - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the snapshot chains of disks. A snapshot chain is a chain of all the snapshots created for a disk. A disk corresponds to a chain of snapshots.

Operation description

Usage notes

Take note of the following items:

You can specify multiple request parameters, such as RegionId, DiskIds, and InstanceId, to query snapshot chains. Specified parameters have logical AND relations.
Only the specified parameters are used as filter conditions. If the DiskIds and SnapshotLinkIds parameters are set to empty JSON arrays, the values are considered as valid filter conditions. In this case, an empty result is returned.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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 a JSON array that contains a maximum of 100 disk IDs. Separate the disk IDs with commas (,).	["d-bp1d6tsvznfghy7y**", "d-bp1ippxbaql9zet7", … "d-bp1ib7bcz07lcxa9**"]
SnapshotLinkIds	string	No	The snapshot chain IDs. You can specify a JSON array that contains a maximum of 100 snapshot chain IDs. Separate the snapshot chain IDs with commas (,).	["sl-bp1grgphbcc9brb5**", "sl-bp1c4izumvq0i5bs", … "sl-bp1akk7isz866dds**"]
PageNumber	integer	No	The page number. Page starts from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	50

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	50
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	9
SnapshotLinks	object []	The details of the snapshot chains.
InstantAccess	boolean	Indicates whether the instant access feature is enabled. Valid values: true: The instant access feature is enabled. This feature can be enabled only for enhanced SSDs (ESSDs). false: The instant access feature is disabled. The snapshot is a normal snapshot for which the instant access feature is disabled. Note This parameter is no longer used. By default, new normal 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	long	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 category of the snapshot.	standard

Examples

Sample success responses

JSONformat

{
  "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.	An internal error has occurred. Try again later.

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