All Products
Search
Document Center

ApsaraDB for MyBase:DescribeDedicatedHostDisks

Last Updated:Mar 01, 2024

Queries the information about 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DedicatedHostIdstringYes

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

ch-bp183v72jr033****
RegionIdstringYes

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

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
DedicatedHostIdstring

The host ID.

ch-bp183v72jr033****
RequestIdstring

The request ID.

C6C6CF41-F284-4F63-AB4D-44FACE3BASQW
Disksobject []

The queried disks.

Typestring

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

  • system: system disk.
  • data: data disk.
data
Statusstring

The state of the ESSD. Valid values:

  • In_use
  • Available
  • Attaching
  • Detaching
  • Creating
  • ReIniting
In_use
PerformanceLevelstring

The performance level of the ESSD.

Note ApsaraDB for MyBase provides the following types of ESSDs: ESSD, PL2 ESSD, and PL3 ESSD. The higher performance level delivers better ESSD performance.
PL1
DiskIdstring

The ID of the ESSD or local SSD.

d-bp1dffpog8r2eowd****
MaxThroughputinteger

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

284
MaxIOPSinteger

The maximum IOPS of the disk, which is displayed after being divided by 10,000.

18250
HasDBInstanceboolean

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

  • true
  • false
true
Devicestring

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

/dev/xvdb
Sizeinteger

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

329
ZoneIdstring

The zone ID of the ESSD or local SSD.

cn-hangzhou-h
Categorystring

The storage type of the host. Valid values:

  • cloud_ssd: local SSD.
  • cloud_essd: ESSD.
cloud_essd
DBInstanceIdstring

The ID of the instance that uses the disk.

rm-bp121zcqr5h8m****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidUserId.NotSupportThe user ID has no permission.You are not authorized to perform this operation.
404HostInfo.NotFoundThe specified host info is not found.The specified host information is not found.
404InvalidDedicatedHostGroup.NotFoundThe specified DedicatedHostGroup does not exist.The specified cluster does not exist.
404InvalidParameterThe parameter is invalid.The parameter is invalid.

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

Change history

Change timeSummary of changesOperation
No change history