Queries the details of disks on a host.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDedicatedHostDisks

The operation that you want to perform. Set the value to DescribeDedicatedHostDisks.

DedicatedHostId String Yes ch-bp183v72jr033****

The ID of the host. You can log on to the ApsaraDB MyBase console and go to the Hosts page to view the host ID.

RegionId String Yes cn-hangzhou

The ID of the region where the host is deployed. You can log on to the ApsaraDB MyBase console to view the region ID.

Response parameters

Parameter Type Example Description
DedicatedHostId String ch-bp183v72jr033****

The ID of the host.

RequestId String C6C6CF41-F284-4F63-AB4D-44FACE3BASQW

The ID of the request.

Disks Array of Disks

Details of the disks.

Type String data

The disk type of the enhanced SSD (ESSD) or the local SSD. Valid values:

  • system: system disk
  • data: data disk
Status String In_use

The state of the ESSD. Valid values:

  • In_use
  • Available
  • Attaching
  • Detaching
  • Creating
  • ReIniting
PerformanceLevel String PL1

The performance level of the ESSD.

Note ApsaraDB MyBase supports ESSDs at three performance levels: ESSD, PL2 ESSD, and PL3 ESSD. A higher performance level delivers better disk performance.
DiskId String d-bp1dffpog8r2eowd****

The ID of the ESSD or the local SSD.

MaxThroughput Integer 284

The maximum throughput of the disk. Unit: MB/s.

MaxIOPS Integer 18250

The maximum IOPS of the disk. Unit: 10,000.

HasDBInstance Boolean true

Indicates whether the disk is attached to instances. Valid values:

  • true: The disk is attached to instances.
  • false: The disk is not attached to instances.
Device String /dev/xvdb

The device name of the instance to which the ESSD or the local SSD is attached.

Size Integer 329

The size of the ESSD or the local SSD. Unit: GB.

ZoneId String cn-hangzhou-h

The zone ID of the ESSD or the local SSD.

Category String cloud_essd

The storage type of the host. Valid values:

  • cloud_ssd: local SSD
  • cloud_essd: ESSD
DBInstanceId String rm-bp121zcqr5h8m****

The ID of the instance that uses the disk.

Examples

Sample requests

http(s)://cddc.aliyuncs.com/?Action=DescribeDedicatedHostDisks
&DedicatedHostId=ch-bp183v72jr033****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDedicatedHostDisksResponse>
<DedicatedHostId>ch-bp183v72jr033****</DedicatedHostId>
<RequestId>C6C6CF41-F284-4F63-AB4D-44FACE3BASQW</RequestId>
<Disks>
    <Status>In_use</Status>
    <HasDBInstance>true</HasDBInstance>
    <MaxThroughput/>
    <Type>data</Type>
    <Category>cloud</Category>
    <ZoneId>cn-hangzhou-h</ZoneId>
    <DBInstanceId>rm-bp121zcqr5h8m****</DBInstanceId>
    <Size>329</Size>
    <Device>/dev/xvdb</Device>
    <PerformanceLevel>PL1</PerformanceLevel>
    <MaxIOPS>18250</MaxIOPS>
    <DiskId>d-bp1dffpog8r2eowd****</DiskId>
</Disks>
</DescribeDedicatedHostDisksResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DedicatedHostId" : "ch-bp183v72jr033****",
  "RequestId" : "C6C6CF41-F284-4F63-AB4D-44FACE3BASQW",
  "Disks" : {
    "Status" : "In_use",
    "HasDBInstance" : true,
    "MaxThroughput" : "",
    "Type" : "data",
    "Category" : "cloud",
    "ZoneId" : "cn-hangzhou-h",
    "DBInstanceId" : "rm-bp121zcqr5h8m****",
    "Size" : 329,
    "Device" : "/dev/xvdb",
    "PerformanceLevel" : "PL1",
    "MaxIOPS" : 18250,
    "DiskId" : "d-bp1dffpog8r2eowd****"
  }
}

Error codes

HTTP status code Error code Error message Description
400 InvalidUserId.NotSupport The user ID has no permission. The error message returned because the specified user does not have permissions.
404 HostInfo.NotFound The specified host info is not found. The error message returned because the specified host information is not found.
404 InvalidDedicatedHostGroup.NotFound The specified DedicatedHostGroup does not exist. The error message returned because the specified dedicated cluster does not exist.
404 InvalidParameter The parameter is invalid. The error message returned because the specified parameter is invalid.

For a list of error codes, visit the API Error Center.