DescribeDisks - ENS - Alibaba Cloud Documentation Center

Queries the information about one or more disks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ens:DescribeDisks	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
EnsRegionId	string	No	The ID of the edge node.	cn-kunming-telecom
DiskId	string	No	The ID of the disk.	d-5soak1gqa507lyfzvz0xo****
DiskName	string	No	The name of the disk.	DiskName
PageNumber	string	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	string	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10
Status	string	No	The status of the disk. Valid values: In-use: The disk is in use. Available: The disk can be attached. Attaching: The disk is being attached. Detaching: The disk is being detached. Creating: The disk is being created. ReIniting: The disk is being reset. Deleting: The disk is being released. Deleted: The disk is released. Expiring: The disk is about to expire.	Available
Type	string	No	The type of the disk. Valid values: system: system disk. data: data disk.	system
Category	string	No	The category of the disk. cloud_efficiency: ultra disk. cloud_ssd: all-flash disk. local_hdd: local HDD. local_ssd: local SSD.	local_ssd
DiskChargeType	string	No	The billing method. prePay: subscription. postpay: pay-as-you-go.	prepay
EnsRegionIds	string	No	The node information.	["cn-suzhou-telecom","cn-chengdu-telecom"]
DiskIds	string	No	The ID of the disk.	[\"d-wz99njena32z90ki****\"]
OrderByParams	string	No	The order in which you want to sort the returned data. Example: {"EnsRegionId":"desc"}. By default, the nodes are sorted by IDs in descending order.	{ "DiskNameSort":"desc","EnsRegionIdSort":"asc" }
DiskType	string	No	The purchase method of the disk. Valid values: ServiceDisk: The disk is purchased when ENS is activated. ResoureDisk: The disk is purchased when the instance is created. PostPayDisk: The disk is separately purchased.	PostPayDisk
InstanceId	string	No	The ID of the instance to which the disk is attached.	i-5t77rb0yoz79m28ku60sx****
SnapshotId	string	No	The ID of the snapshot.	s-897654321****

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The returned service code. 0 indicates that the request was successful.	0
Disks	array<object>	The information about the disks.
Disks	object	The information about the disks.
Category	string	The category of the disk. cloud_efficiency: ultra disk. cloud_ssd: all-flash disk. local_hdd: local HDD. local_ssd: local SSD.	local_ssd
CreationTime	string	The time when the disk was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-11-11T14:34:55+08:00
DiskChargeType	string	The billing method of the cloud disk or local disk. Valid values: prepaid: subscription. postpaid: pay-as-you-go.	prepaid
DiskId	string	The ID of the disk.	d-5svum1dx1w4a4spr54lgr****
DiskName	string	The name of the disk.	fvt-ecs-5cf0****
EnsRegionId	string	The ID of the edge node.	cn-guangzhou-10
InstanceId	string	The ID of the instance.	i-5t77rb0yoz79m28ku60sx****
InstanceName	string	The name of the instance.	Edge Prod Environment Streaming Machine -1063
Size	integer	The size of the disk. Unit: MiB.	20
Status	string	The status of the disk. Valid values: In-use: The disk is in use. Available: The disk can be attached. Attaching: The disk is being attached. Detaching: The disk is being detached. Creating: The disk is being created. ReIniting: The disk is being reset.	Available
Type	string	The type of the cloud disk or local disk. Valid values: 1: system disk. 2: data disk.	1
Portable	boolean	Indicates whether the cloud disk or local disk is removable. Valid values: true: The disk is removable. A removable disk can independently exist and can be attached to or detached from an instance within the same zone. false: The disk is not removable. A disk that is not removable cannot independently exist or be attached to or detached from an instance within the same zone. If disks are of the following categories or types, the Portable value is false and the disks have the same lifecycle as their attached instances: Local HDDs Local SSDs Data disks that use the subscription billing method	true
SnapshotId	string	The ID of the snapshot.	s-bp67acfmxazb4p****
SerialId	string	The serial number.	123
Encrypted	boolean	Indicates whether the cloud disk is encrypted. Valid values: true false	False
EncryptedKeyId	string	The ID of the Key Management Service (KMS) key that is used for the cloud disk.	05467897a-4262-4802-b8cb-00d3fb40****
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page. Maximum value: 50. Default value: 10.	50
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCount	integer	The total number of returned pages.	13

Examples

Sample success responses

JSONformat

{
  "Code": 0,
  "Disks": {
    "Disks": [
      {
        "Category": "local_ssd",
        "CreationTime": "2021-11-11T14:34:55+08:00",
        "DiskChargeType": "prepaid",
        "DiskId": "d-5svum1dx1w4a4spr54lgr****",
        "DiskName": "fvt-ecs-5cf0****",
        "EnsRegionId": "cn-guangzhou-10",
        "InstanceId": "i-5t77rb0yoz79m28ku60sx****",
        "InstanceName": "Edge Prod Environment Streaming Machine -1063\n",
        "Size": 20,
        "Status": "Available",
        "Type": "1",
        "Portable": true,
        "SnapshotId": "s-bp67acfmxazb4p****",
        "SerialId": "123",
        "Encrypted": true,
        "EncryptedKeyId": "05467897a-4262-4802-b8cb-00d3fb40****"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 13
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter domainName 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.	-

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

Change history

Change time	Summary of changes	Operation
2024-11-18	The Error code has changed. The response structure of the API has changed	View Change Details
2023-11-14	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-17	The Error code has changed. The response structure of the API has changed	View Change Details
2023-07-20	API Description Update. The Error code has changed. The response structure of the API has changed	View Change Details
2023-03-02	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2021-10-28	Add Operation	View Change Details