DescribeDedicatedBlockStorageClusterDisks - Elastic Compute Service

Queries the details of one or more disks in a dedicated block storage cluster.

Operation description

You can use one of the following methods to check the responses:
- Method 1: Use NextToken to configure the query token. Set the value to the NextToken value that is returned in the last call to the DescribeDisks operation. Then, use MaxResults to specify the maximum number of entries to return on each page.
- Method 2: Use PageSize to specify the number of entries to return on each page and then use PageNumber to specify the number of the page to return.
  
  You can use only one of the preceding methods. If a large number of entries are to be returned, we recommend that you use method 1. When NextToken is specified, PageSize and PageNumber do not take effect and TotalCount in the response is invalid.
A disk that has the multi-attach feature enabled can be attached to multiple instances. You can query the attachment information of the disk based on the Attachment values in the response.

When you call an API operation by using Alibaba Cloud CLI, you must specify request parameter values of different data types in the required formats. For more information, see Parameter format overview.

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
ebs:DescribeDedicatedBlockStorageClusterDisks	get	*DedicatedBlockStorageCluster `acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/{#DedicatedBlockStorageClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the dedicated block storage cluster resides. You can call the DescribeRegions operation to query the most recent region list.	cn-heyuan
MaxResults	long	No	The maximum number of entries to return on each page. Maximum value: 500. Default value: 10.	10
NextToken	string	No	The query token. Set the value to the NextToken value returned in the previous call to the DescribeDedicatedBlockStorageClusterDisks operation. Leave this parameter empty the first time you call this operation.	AAAAAdDWBF2
DbscId	string	Yes	The ID of the dedicated block storage cluster.	dbsc-cn-od43bf****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	11B55F58-D3A4-4A9B-9596-342420D0****
NextToken	string	The query token returned in this call.	AAAAAdDWBF2
Disks	object	Details about the cloud disks.
Disk	array<object>	Details about the cloud disks.
Disk	object
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	all
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.
tags	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	long	The maximum number of IOPS.	4000
Throughput	long	The maximum number of BPS.	350
ProvisionedIops	long	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.	50000
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.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "11B55F58-D3A4-4A9B-9596-342420D0****",
  "NextToken": "AAAAAdDWBF2",
  "Disks": {
    "Disk": [
      {
        "DiskId": "d-bp67acfmxazb4p****",
        "DiskName": "testDiskName",
        "Status": "In_use",
        "Type": "all",
        "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": 350,
        "ProvisionedIops": 50000,
        "BurstingEnabled": true
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.

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

Change history

Change time	Summary of changes	Operation
2023-04-06	The response structure of the API has changed	View Change Details