Query snapshot information by using DescribeSnapshots - ENS - Alibaba Cloud - ENS

Queries snapshot information by calling DescribeSnapshots.

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

ens:DescribeSnapshots

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EnsRegionId	string	No	The ID of the ENS edge zone. You can call DescribeEnsRegions to query edge zone IDs.	cn-hangzhou
DiskId	string	No	The ID of the specified cloud disk.	d-bp67acfmxazb4p****
SnapshotId	string	No	The snapshot ID. The value can be a JSON array that consists of up to 100 snapshot IDs. Separate multiple IDs with commas (,).	sp-bp67acfmxazb4p****
EnsRegionIds	string	No	The array of ENS edge zone IDs. Array length: 1 to 100.	["cn-suzhou-telecom","cn-chengdu-telecom"]
SnapshotName	string	No	The display name of the snapshot. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. It cannot start with `http://` or `https://`. It can contain digits, colons (:), underscores (_), or hyphens (-).	testSnapshotName
InstanceId	string	No	The instance ID.	i-bp67acfmxazb4p****
PageNumber	integer	No	The page number of the current query.	1
PageSize	integer	No	The number of entries per page in a paged query.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
Snapshots	array<object>	The collection of snapshot details.
	object
SnapshotId	string	The snapshot ID.	s-bp67acfmxazb4p****
CreationTime	string	The creation time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ss format. The time is displayed in UTC.	2020-08-20 14:52:28
Status	string	The snapshot status. Valid values: creating: The snapshot is being created. available: The snapshot is available. deleting: The snapshot is being deleted. error: An error occurred.	available
Size	string	The disk capacity. Unit: MiB.	40
SourceDiskId	string	The ID of the source cloud disk. This field is retained even if the source cloud disk of the snapshot has been released.	d-bp67acfmxazb4ph****
SourceDiskType	string	The disk property. Valid values: 1: system cloud disk. 2: data cloud disk.	1
SourceDiskCategory	string	The disk type. Valid values: cloud_efficiency: ultra cloud disk. cloud_ssd: all-flash cloud disk. local_hdd: local HDD. local_ssd: local SSD.	cloud_efficiency
SnapshotName	string	The display name of the snapshot. This field is returned if a display name was specified when the snapshot was created.	testSnapshotName
Description	string	The description.	testDescription
EnsRegionId	string	The ID of the ENS edge zone.	cn-beijing-15
SourceSnapshotId	string	The ID of the source snapshot.	s-bpdfer893jfkdqe****
SourceEnsRegionId	string	The ID of the source ENS edge zone.	cn-hangzhou-27
SnapshotType	string	The snapshot type.	manual
PageNumber	integer	The page number of the current query.	1
PageSize	integer	The number of entries per page in a paged query.	10
TotalCount	integer	The total number of snapshots.	1
RequestId	string	The request ID.	9635ED2E-3103-1606-84D4-9F8E816B19F9

Examples

Success response

JSON format

{
  "Snapshots": [
    {
      "SnapshotId": "s-bp67acfmxazb4p****",
      "CreationTime": "2020-08-20 14:52:28",
      "Status": "available",
      "Size": "40",
      "SourceDiskId": "d-bp67acfmxazb4ph****",
      "SourceDiskType": "1",
      "SourceDiskCategory": "cloud_efficiency",
      "SnapshotName": "testSnapshotName",
      "Description": "testDescription",
      "EnsRegionId": "cn-beijing-15",
      "SourceSnapshotId": "s-bpdfer893jfkdqe****",
      "SourceEnsRegionId": "cn-hangzhou-27",
      "SnapshotType": "manual"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RequestId": "9635ED2E-3103-1606-84D4-9F8E816B19F9"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.
400	InstanceIdNotFound	The input parameter instancdId that is not found.	The specified instance ID does not exist.
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.