Queries disk information for a host.


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 call the DescribeDedicatedHosts operation to query the host ID.

RegionId String No cn-hangzhou

The region ID of the host. You can view the region where your host is deployed on the Host Information tab of the host details page in the ApsaraDB MyBase console. Then, you can query the region ID based on the region name. For more information, see Region IDs.

Response parameters

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

The ID of the host.

Disks Array of Disks

The details about the disks.

Category String cloud_essd

The storage type of the host. Valid values:

  • cloud_essd: indicates that the host uses enhanced SSDs (ESSDs).
  • local_ssd: indicates that the host uses local SSDs.
DBInstanceId String rm-bp121zcqr5h8m****

The ID of the instance that uses the disk.

Device String /dev/xvdb

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

DiskId String d-bp1dffpog8r2eowd****

The ID of the ESSD or the local SSD.

HasDBInstance Boolean true

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

  • true: The disk is attached to one or more instances.
  • false: The disk is not attached to instances.
MaxIOPS Integer 18250

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

MaxThroughput Integer 284

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

PerformanceLevel String PL1

The performance level of the ESSD.

Note ApsaraDB MyBase provides ESSDs of the following performance levels: PL1, PL2, and PL3. An ESSD with a higher performance level provides better storage performance.
Size Integer 329

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

Status String In_use

The state of the ESSD. Valid values:

  • In_use
  • Available
  • Attaching
  • Detaching
  • Creating
  • ReIniting
Type String data

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

  • system: a system disk
  • data: a data disk
ZoneId String cn-hangzhou-h

The zone ID of the ESSD or the local SSD.

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

The ID of the request.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

    "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

HttpCode Error code Error message Description
400 InvalidUserId.NotSupport The user ID has no permission. The error message returned because you are not authorized to perform this operation.
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 parameters are invalid.

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