Query disk information using DescribeDisks - ENS

Describes one or more disks.

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

get

*Disk

acs:ens::{#accountId}:disk/{#DiskId}

None

Request parameters

Parameter	Type	Required	Description	Example
EnsRegionId	string	No	The ID of the Edge Node Service (ENS) 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 page number. The value must be a number that is greater than 0. Default value: 1.	1
PageSize	string	No	The number of entries per 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 is available. Attaching: The disk is being attached. Detaching: The disk is being detached. Creating: The disk is being created. ReIniting: The disk is being re-initialized. Deleting: The disk is being deleted. Deleted: The disk is deleted. 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. Valid values: cloud_efficiency: ultra disk cloud_ssd: standard SSD local_hdd: local HDD local_ssd: local SSD	local_ssd
DiskChargeType	string	No	The billing method of the disk. Valid values: PrePaid: subscription PostPaid: pay-as-you-go	prepay
EnsRegionIds	string	No	The list of node IDs.	["cn-suzhou-telecom","cn-chengdu-telecom"]
DiskIds	string	No	The ID of the disk.	[\"d-wz99njena32z90ki****\"]
OrderByParams	string	No	The sorting order. The value is a JSON string. Example: {"EnsRegionId":"desc"}. By default, results are sorted by node ID in descending order.	{ "DiskNameSort":"desc","EnsRegionIdSort":"asc" }
DiskType	string	No	The purchasing model of the disk. Valid values: ServiceDisk: The disk is created for an edge service. ResoureDisk: The disk is purchased with the instance. PostPayDisk: The disk is purchased separately.	PostPayDisk
InstanceId	string	No	The instance to which the disk is attached.	i-5t77rb0yoz79m28ku60sx****
SnapshotId	string	No	The ID of the snapshot.	s-897654321****

Response elements

Element	Type	Description	Example
	object	The response object.
Code	integer	The status code. A value of 0 indicates a successful response.	0
Disks	object	The information about the disks.
Disks	array<object>	The list of disks.
	array<object>	The details of a disk.
Category	string	The category of the disk. Valid values: `cloud_efficiency`: Efficiency Cloud Disk `cloud_ssd`: SSD Cloud Disk `local_hdd`: local HDD `local_ssd`: local SSD	local_ssd
CreationTime	string	The time when the disk was created. The time is displayed in UTC and follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format.	2021-11-11T14:34:55+08:00
DiskChargeType	string	The billing method of the 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 Service (ENS) node.	cn-guangzhou-10
InstanceId	string	The ID of the instance to which the disk is attached.	i-5t77rb0yoz79m28ku60sx****
InstanceName	string	The name of the instance to which the disk is attached.	prod-1063
Description	string	The description of the disk.	disk-description
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 is available for attachment. `Attaching`: The disk is being attached. `Detaching`: The disk is being detached. `Creating`: The disk is being created. `ReIniting`: The disk is being re-initialized.	Available
Type	string	The type of the disk. Valid values: `1`: system disk `2`: data disk	1
Portable	boolean	Indicates whether the disk can be detached. Valid values: `true`: The disk can exist independently and can be attached to or detached from an instance in the same zone. `false`: The disk cannot exist independently. Its lifecycle is bound to that of the instance. The Portable property is false for the following disk types: Local HDD Local SSD Subscription data disk	true
SnapshotId	string	The ID of the snapshot from which the disk is created.	s-bp67acfmxazb4p****
SerialId	string	The serial number of the disk.	123
Encrypted	boolean	Indicates whether the disk is encrypted. Valid values: true: The disk is encrypted. false: The disk is not encrypted.	false
EncryptedKeyId	string	The ID of the Key Management Service (KMS) key used for the disk.	05467897a-4262-4802-b8cb-00d3fb40****
DeleteWithInstance	boolean	Indicates whether the disk is released when the instance is released. Valid values: `true`: The disk is released when the instance is released. `false`: The disk is not released when the instance is released.	false
Tags	object	The tags of the disk.
Tags	array<object>	A list of tags.
	object	The details of a tag.
Key	string	The key of the tag.
Value	string	The value of the tag.
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page. Maximum value: 50. Default value: 10.	50
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCount	integer	The total number of entries returned.	13

Examples

Success response

JSON format

{
  "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": "prod-1063",
        "Description": "disk-description",
        "Size": 20,
        "Status": "Available",
        "Type": "1",
        "Portable": true,
        "SnapshotId": "s-bp67acfmxazb4p****",
        "SerialId": "123",
        "Encrypted": false,
        "EncryptedKeyId": "05467897a-4262-4802-b8cb-00d3fb40****",
        "DeleteWithInstance": false,
        "Tags": {
          "Tags": [
            {
              "Key": "",
              "Value": ""
            }
          ]
        }
      }
    ]
  },
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.