Use DescribeDedicatedHostDisks to query disks on a host - ApsaraDB for MyBase - Alibaba Cloud - ApsaraDB for MyBase

Queries the information about disks on a host.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
DedicatedHostId	string	Yes	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****
RegionId	string	No	The region ID of the host. You can log on to the ApsaraDB for MyBase console to view the region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
DedicatedHostId	string	The host ID.	ch-bp183v72jr033****
RequestId	string	The request ID.	C6C6CF41-F284-4F63-AB4D-44FACE3BASQW
Disks	array<object>	The queried disks.
	object
Type	string	The disk type of the enhanced SSD (ESSD) or local SSD. Valid values: system: system disk. data: data disk.	data
Status	string	The state of the ESSD. Valid values: In_use Available Attaching Detaching Creating ReIniting	In_use
PerformanceLevel	string	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
DiskId	string	The ID of the ESSD or local SSD.	d-bp1dffpog8r2eowd****
MaxThroughput	integer	The maximum throughput of the disk. Unit: MB/s.	284
MaxIOPS	integer	The maximum IOPS of the disk, which is displayed after being divided by 10,000.	18250
HasDBInstance	boolean	Indicates whether the disk is attached to instances. Valid values: true false	true
Device	string	The device name of the instance to which the ESSD or local SSD is attached.	/dev/xvdb
Size	integer	The size of the ESSD or local SSD. Unit: GB.	329
ZoneId	string	The zone ID of the ESSD or local SSD.	cn-hangzhou-h
Category	string	The storage type of the host. Valid values: cloud_ssd: local SSD. cloud_essd: ESSD.	cloud_essd
DBInstanceId	string	The ID of the instance that uses the disk.	rm-bp121zcqr5h8m****

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	InvalidUserId.NotSupport	The user ID has no permission.	You are not authorized to perform this operation.
404	HostInfo.NotFound	The specified host info is not found.	The specified host information is not found.
404	InvalidDedicatedHostGroup.NotFound	The specified DedicatedHostGroup does not exist.	The specified cluster does not exist.
404	InvalidParameter	The parameter is invalid.	The parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.