Queries the information about the hosts in a dedicated cluster.
Operation description
Dedicated clusters allow you to manage a number of instances at a time. You can create multiple dedicated clusters in a single region. Each dedicated cluster consists of multiple hosts. You can create multiple instances on each host. For more information, see What is ApsaraDB MyBase?
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | No | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
DedicatedHostGroupId | string | No | The dedicated cluster ID. You can call the DescribeDedicatedHostGroups operation to query the dedicated cluster ID. | dhg-7a9xxxxxxxx |
OrderId | long | No | The order ID. | 102565235 |
HostType | string | No | The storage type of the host. Valid values:
| dhg_cloud_ssd |
HostStatus | string | No | The status of the host. Valid values:
| 1 |
AllocationStatus | string | No | Specifies whether instances can be deployed on the host. Valid values:
| 1 |
ZoneId | string | No | The zone ID. | cn-hangzhou-i |
DedicatedHostId | string | No | The ID of the host in the dedicated cluster. | ch-t4nn100ddxxxxxxxx |
Response parameters
Examples
Sample success responses
JSON
format
{
"DedicatedHostGroupId": "dhg-7a9xxxxxxxx",
"RequestId": "C860658E-68A6-46C1-AF6E-3AE7C4D3CACF",
"DedicatedHosts": {
"DedicatedHosts": [
{
"HostType": "dhg_cloud_ssd",
"HostStorage": "2097152",
"MemoryUsed": "16384",
"DedicatedHostGroupId": "dhg-7a9xxxxxxxx",
"AllocationStatus": "1",
"StorageUsed": "0",
"DedicatedHostId": "i-bpxxxxxxx",
"MemAllocationRatio": "90",
"CreatedTime": "2021-03-25 17:29:06.0",
"IPAddress": "192.xx.xx.xx",
"HostStatus": "1",
"HostName": "testHost1",
"HostCPU": "8",
"InstanceNumber": "4",
"OpenPermission": "3",
"CpuUsed": "4",
"VPCId": "vpc-bpxxxxxxx",
"HostClass": "ecs.i2.16xlarge",
"EndTime": "2021-04-25T16:00:00Z",
"VSwitchId": "vsw-bpxxxxxxx",
"CPUAllocationRatio": "200",
"ZoneId": "cn-hangzhou-i",
"ImageCategory": "WindowsWithMssqlStdLicense",
"Engine": "mysql",
"DiskAllocationRatio": "200",
"HostMem": "32238",
"BastionInstanceId": "bastionhost-cn-m7xxxxxxxx",
"AccountName": "test123"
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidUserId.NotSupport | The userid have no permission. | The user does not have permissions. |
404 | InvalidDedicatedHostGroup.NotFound | Specified DedicatedHostGroup does not exists. | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2022-06-23 | API Description Update. The Error code has changed | View Change Details |