Use DescribeDedicatedBlockStorageClusterDisks to query cloud disks in a dedicated block storage cluster - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries information about one or more cloud disks that you have created in a dedicated block storage cluster.

Operation description

The following two methods are supported to view returned data:
- Method 1: Use NextToken to set a query token. Set its value to the NextToken value returned by the previous call to DescribeDisks, and use MaxResults to set the maximum number of entries per page.
- Method 2: Use PageSize to set the number of entries per page, and use PageNumber to set the page number.
You can use only one of the preceding methods. When a large number of entries are returned, we recommend that you use Method 1. If you set NextToken, the PageSize and PageNumber request parameters do not take effect, and TotalCount in the returned data is invalid.
Cloud disks with the multi-attach feature enabled can be attached to multiple instances. You can view all attachment information of a cloud disk based on the Attachment list in the response.

When you invoke an API operation by using Cloud Assistant CLI, specify request parameters of different data types in the required formats. For more information, see Parameter format of CLI.

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

ebs:DescribeDedicatedBlockStorageClusterDisks

get

*DedicatedBlockStorageCluster

acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/{#DedicatedBlockStorageClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the dedicated block storage cluster. You can call DescribeRegions to query the most recent region list.	cn-heyuan
MaxResults	integer	No	The maximum number of entries per page for a paged query. Maximum value: 500. Default value: 10.	10
NextToken	string	No	The pagination token. Set this parameter to the NextToken value returned in the previous call. You do not need to set this parameter for the first request.	AAAAAdDWBF2
DbscId	string	Yes	The dedicated block storage cluster ID.	dbsc-cn-od43bf****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	11B55F58-D3A4-4A9B-9596-342420D0****
NextToken	string	The pagination token returned in this call.	AAAAAdDWBF2
Disks	object	The collection of cloud disk information.
Disk	array<object>	The collection of cloud disk information.
	array<object>	The collection of cloud disk information.
DiskId	string	The ID of the cloud disk.	d-bp67acfmxazb4p****
DiskName	string	The name of the cloud disk.	testDiskName
Status	string	The state of the cloud disk. For more information, see Disk states. Valid values: In_use Available Attaching Detaching Creating ReIniting	In_use
Type	string	The type of the disk. Valid values: system: system disk data: data disk	system
PerformanceLevel	string	The performance level of the enhanced SSD (ESSD). Valid values: PL0: A single ESSD can deliver up to 10,000 random read/write IOPS. PL1: A single ESSD can deliver up to 50,000 random read/write IOPS. PL2: A single ESSD can deliver up to 100,000 random read/write IOPS. PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.	PL0
BdfId	string	This parameter is currently in invitational preview and unavailable for general users.	null
EnableAutoSnapshot	boolean	Indicates whether the automatic snapshot policy feature is enabled for the cloud disk.	false
StorageSetId	string	The ID of the storage set.	ss-i-bp1j4i2jdf3owlhe****
StorageSetPartitionNumber	integer	The maximum number of partitions in the storage set.	11
DeleteAutoSnapshot	boolean	Indicates whether the automatic snapshots of the cloud disk are deleted when the disk is released. Valid values: true: The automatic snapshots of the cloud disk are deleted when the disk is released. false: The automatic snapshots of the cloud disk are retained when the disk is released. Snapshots that are created by calling the CreateSnapshot operation or by using the Elastic Compute Service (ECS) console are retained and not affected by this parameter.	false
StorageClusterId	string	The ID of the dedicated block storage cluster to which the cloud disk belongs. If your cloud disk belongs to the public block storage cluster, an empty value is returned.	dbsc-j5e1sf2vaf5he8m2****
Encrypted	boolean	Indicates whether the cloud disk is encrypted.	false
MountInstanceNum	integer	The number of instances to which the Shared Block Storage device is attached.	1
Description	string	The description of the cloud disk.	testDescription
Device	string	The device name of the cloud disk on its associated instance. Example: /dev/xvdb. Take note of the following items: This parameter has a value only when the `Status` value is `In_use`. This parameter is empty for cloud disks that have the multi-attach feature enabled. You can query the attachment information of the cloud disk based on the `Attachment` values. Note This parameter will be removed in the future. We recommend that you use other parameters to ensure future compatibility.	/dev/xvdb
Portable	boolean	Indicates whether the cloud disk is removable.	false
ImageId	string	The ID of the image that was used to create the instance. This parameter is empty unless the cloud disk was created from an image. The value of this parameter remains unchanged throughout the lifecycle of the cloud disk.	m-bp13aqm171qynt3u***
KMSKeyId	string	The ID of the Key Management Service (KMS) key used by the cloud disk.	0e478b7a-4262-4802-b8cb-00d3fb40****
DeleteWithInstance	boolean	Indicates whether the cloud disk is released when its associated instance is released. Valid values: true: The cloud disk is released when its associated instance is released. false: The cloud disk is retained when its associated instance is released.	true
DetachedTime	string	The time when the cloud disk was last detached.	2021-06-07T21:01:22Z
SourceSnapshotId	string	The ID of the snapshot that was used to create the cloud disk. This parameter is empty unless the cloud disk was created from a snapshot. The value of this parameter remains unchanged throughout the lifecycle of the cloud disk.	s-bp67acfmxazb4p****
InstanceId	string	The ID of the instance to which the cloud disk is attached. Take note of the following items: This parameter has a value only when the `Status` value is `In_use`. This parameter is empty for cloud disks that have the multi-attach feature enabled. You can query the attachment information of the cloud disk based on the `Attachment` values.	i-bp67acfmxazb4q****
Size	integer	The size of the disk. Unit: GiB.	60
RegionId	string	The region ID of cloud disk.	cn-heyuan
ZoneId	string	The zone ID of cloud disk.	cn-heyuan-i
AttachedTime	string	The time when the cloud disk was last attached. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mmZ format. The time is displayed in UTC.	2021-06-07T06:08:56Z
Category	string	The category of the disk. A value of cloud_essd indicates that the disk is an ESSD.	cloud_essd
MultiAttach	string	Indicates whether the multi-attach feature was enabled for the cloud disk.	Disabled
Tags	array<object>	The tags of the cloud disk.
	object
TagValue	string	The tag value of the cloud disk.	TestValue
TagKey	string	The tag key of the cloud disk.	TestKey
DiskChargeType	string	The billing method of the cloud disk. Valid values: PrePaid: subscription PostPaid: pay-as-you-go	PrePaid
IOPS	integer	The maximum number of IOPS.	4000
Throughput	integer	The maximum number of BPS.	100
ProvisionedIops	integer	The provisioned read/write IOPS of the ESSD AutoPL disk. Note This parameter is available only if the DiskCategory parameter is set to cloud_auto. For more information, see ESSD AutoPL disks and Modify the performance configurations of an ESSD AutoPL disk.	40000
BurstingEnabled	boolean	Whether the ESSD AutoPL disk is enabled burst IOPS / BPS. This parameter is available only if the DiskCategory parameter is set to cloud_auto. For more information, see ESSD AutoPL disks.	false

Examples

Success response

JSON format

{
  "RequestId": "11B55F58-D3A4-4A9B-9596-342420D0****",
  "NextToken": "AAAAAdDWBF2",
  "Disks": {
    "Disk": [
      {
        "DiskId": "d-bp67acfmxazb4p****",
        "DiskName": "testDiskName",
        "Status": "In_use",
        "Type": "system",
        "PerformanceLevel": "PL0",
        "BdfId": "null",
        "EnableAutoSnapshot": false,
        "StorageSetId": "ss-i-bp1j4i2jdf3owlhe****",
        "StorageSetPartitionNumber": 11,
        "DeleteAutoSnapshot": false,
        "StorageClusterId": "dbsc-j5e1sf2vaf5he8m2****",
        "Encrypted": false,
        "MountInstanceNum": 1,
        "Description": "testDescription",
        "Device": "/dev/xvdb",
        "Portable": false,
        "ImageId": "m-bp13aqm171qynt3u***",
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "DeleteWithInstance": true,
        "DetachedTime": "2021-06-07T21:01:22Z",
        "SourceSnapshotId": "s-bp67acfmxazb4p****",
        "InstanceId": "i-bp67acfmxazb4q****",
        "Size": 60,
        "RegionId": "cn-heyuan",
        "ZoneId": "cn-heyuan-i",
        "AttachedTime": "2021-06-07T06:08:56Z",
        "Category": "cloud_essd",
        "MultiAttach": "Disabled",
        "Tags": [
          {
            "TagValue": "TestValue",
            "TagKey": "TestKey"
          }
        ],
        "DiskChargeType": "PrePaid",
        "IOPS": 4000,
        "Throughput": 100,
        "ProvisionedIops": 40000,
        "BurstingEnabled": false
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User is not authorized to operate this action.	You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.