调用DescribeDedicatedHosts来查询专属集群的主机信息。

添加主机后,您可以查看主机的详细信息,包括性能监控、CPU总数、内存总量、存储总量等。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDedicatedHosts

系统规定参数,取值:DescribeDedicatedHosts

DedicatedHostGroupId String dhg-h5i4p331f509****

专属集群的ID,可在专属集群控制台的专属集群信息页获取。

RegionId String cn-hangzhou

地域ID。可调用DescribeRegions获取。

OrderId Long 123456789

订单ID,可在专属集群的主机购买页获取。

HostType String dhg_cloud_ssd

主机的存储类型,取值:

  • dhg_cloud_ssd:本地SSD盘。
  • dhg_cloud_ssd:ESSD云盘。
    说明 当前支持本地SSD盘ESSD云盘,不同引擎支持的存储类型不同,请以控制台为准。
AllocationStatus String 1

主机是否可分配实例,取值:

  • Allocatable:该主机允许实例分配。
  • Suspended:该主机停止实例分配。
HostStatus String 1

主机状态,取值:

  • 0:创建中
  • 1:运行中
  • 2:故障中
  • 3:准备下线
  • 4:维护中
  • 5:已下线
  • 6:重启中
  • 7:锁定中
说明 当主机出现故障时,主机会下线,下线过程中,主机会迁移实例数据。
ZoneId String ap-southeast-1a

可用区ID,可在专属集群控制台的主机信息页获取。

DedicatedHostId String dhg-6w7q18iwt5joxxxx

专属集群的主机ID,可在专属集群控制台的主机信息页获取。

PageNumbers Integer 100

页码。

PageSize Integer 30

页面大小。

返回数据

名称 类型 示例值 描述
DedicatedHostGroupId String dhg-6w7q18iwt5jo****

专属集群的ID,可在专属集群控制台的专属集群信息页获取。

DedicatedHosts Array of DedicatedHosts

专属集群主机信息列表。

DedicatedHosts
AccountName String test

自定义主机账号的名称。

  • 由小写字母、数字、下划线组成。
  • 以字母开头,以字母或数字结尾。
  • 最少含2个字符,最多含16个字符。
AllocationStatus String Suspended

主机是否可分配实例,取值:

  • Allocatable:该主机允许实例分配。
  • Suspended:该主机停止实例分配。
BastionInstanceId String bastionhost-cn-xxxxxxxxxxx

关联的堡垒机实例ID,可以在专属集群控制台堡垒机列表页查看堡垒机的实例ID。

CPUAllocationRatio String 0.02500

CPU使用率,单位为百分比,可在专属集群控制台的主机信息页获取。

CpuUsed String 10

CPU使用量,单位为核,可在专属集群控制台的主机信息页获取。

CreatedTime String 2020-10-16 16:30:19.0

创建主机的开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

DedicatedHostGroupId String dhg-6w7q18iwt5jo****

专属集群的ID,即DedicatedHostGroupId的值。

DedicatedHostId String ch-bp*****************

需要查询主机账号的主机ID,可以在查询专属集群主机信息查看主机对应的ID。

DiskAllocationRatio String 0.0

磁盘使用率,单位为百分比。

EcsClassCode String ecs.r5.16xlarge

ECS规格代码。更多信息,请参见ECS实例规格

EndTime String 2021-10-16 16:30:19.0

主机的到期时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Engine String mysql

专属集群的引擎。

HostCPU String 16

主机的CPU,可在专属集群控制台的主机信息页获取。

HostClass String rds.g6.4xlarge

主机的规格,可在专属集群控制台的主机信息页获取。

HostMem String 65536

主机的内存,可在专属集群控制台的主机信息页获取。

HostName String ch-bp15xfnp706tlxxxx

主机的名称,可在专属集群控制台的主机信息页修改。

HostStatus String 1

主机状态,取值:

  • 0:创建中
  • 1:运行中
  • 2:故障中
  • 3:准备下线
  • 4:维护中
  • 5:已下线
  • 6:重启中
  • 7:锁定中
说明 当主机出现故障时,主机会下线,下线过程中,主机会迁移实例数据。
HostStorage String 0

主机的存储总量,单位为GB。

HostType String dhg_cloud_ssd

主机的存储类型。

说明 当前支持本地SSD盘ESSD云盘,不同引擎支持的存储类型不同,请以控制台为准。
IPAddress String 192.168.0.56

主机的IP地址,可在专属集群控制台的主机信息页获取。

ImageCategory String null

主机镜像类型,可在专属集群控制台的主机信息页获取。

InstanceNumber String 1

主机上的实例数。

MemAllocationRatio String 90

内存使用率,单位为百分比。

MemoryUsed String 24576

内存使用量,单位为GB,可在专属集群控制台的主机信息页获取。

OpenPermission String 0

主机OS权限开放状态。

StorageUsed String 588800

存储使用量,单位为GB,可在专属集群控制台的主机信息页获取。

VPCId String vpc-bp1roz55mrbj3ka1sxxxx

专有网络的ID,可在专属集群控制台的主机信息页获取。

VSwitchId String vsw-bp133c8ifzxd3iv6qxxxx

虚拟交换机的ID,可在专属集群控制台的主机信息页获取。

ZoneId String ap-southeast-1a

专属集群所在的可用区。

PageNumbers Integer 2

页码。

PageSize Integer 30

页面大小。

RequestId String D6E068C3-25BC-455A-85FE-45F0B22E****

请求ID。

TotalRecords Integer 5

当前的总页数,取值范围:5~1000,默认为1000

示例

请求示例

http(s)://cddc.aliyuncs.com/?Action=DescribeDedicatedHosts
&DedicatedHostGroupId=dhg-h5i4p331f509****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<DescribeDedicatedHostsReponse>
  <DedicatedHosts>
        <DedicatedHosts>
              <CPUAllocationRatio>0.125000</CPUAllocationRatio>
              <DiskAllocationRatio>0.0</DiskAllocationRatio>
              <InstanceNumber>1</InstanceNumber>
              <DedicatedHostId>ch-bpxxxxxxxxxxxxxxx</DedicatedHostId>
              <CreatedTime>2020-10-16 16:30:19.0</CreatedTime>
              <EndTime>2021-10-16 16:30:19.0</EndTime>
              <DedicatedHostGroupId> dhg-6w7q18iwt5joxxxx</DedicatedHostGroupId>
              <BastionInstanceId>bastionhost-cn-xxxxxxxxxxx</BastionInstanceId>
              <ImageCategory>null</ImageCategory>
              <HostStorage>0</HostStorage>
              <OpenPermission>0</OpenPermission>
              <HostType>dhg_cloud_ssd</HostType>
              <HostMem>65536</HostMem>
              <MemoryUsed>24576</MemoryUsed>
              <HostStatus>1</HostStatus>
              <CpuUsed>10</CpuUsed>
              <Engine>mysql</Engine>
              <HostName>ch-bp15xfnp706tlxxxx</HostName>
              <AllocationStatus>1</AllocationStatus>
              <ZoneId>ap-southeast-1a</ZoneId>
              <MemAllocationRatio>90</MemAllocationRatio>
              <VPCId>vpc-bp1roz55mrbj3ka1sxxxx</VPCId>
              <VSwitchId> vsw-bp133c8ifzxd3iv6qxxxx</VSwitchId>
              <StorageUsed>588800</StorageUsed>
              <HostClass>rds.g6.4xlarge</HostClass>
              <HostCPU>16</HostCPU>
              <EcsClassCode>ecs.r5.16xlarge</EcsClassCode>
              <IPAddress>192.168.0.56</IPAddress>
              <AccountName>test</AccountName>
        </DedicatedHosts>
  </DedicatedHosts>
  <PageSize>30</PageSize>
  <RequestId>D6E068C3-25BC-455A-85FE-45F0B22Exxxx</RequestId>
  <DedicatedHostGroupId> dhg-6w7q18iwt5joxxxx</DedicatedHostGroupId>
  <TotalRecords>3</TotalRecords>
  <PageNumbers>2</PageNumbers>
</DescribeDedicatedHostsReponse>

JSON格式

{"DedicatedHosts":{
    "DedicatedHosts":[{
        "CPUAllocationRatio":"0.125000",
        "DiskAllocationRatio":"0.0",
        "InstanceNumber":"1",
        "DedicatedHostId":"ch-bpxxxxxxxxxxxxxxx",
        "CreatedTime":"2020-10-16 16:30:19.0",
        "EndTime":"2021-10-16 16:30:19.0",
        "DedicatedHostGroupId":" dhg-6w7q18iwt5joxxxx",
        "BastionInstanceId":"bastionhost-cn-xxxxxxxxxxx",
        "ImageCategory":"null",
        "HostStorage":"0",
        "OpenPermission":"0",
        "HostType":"dhg_cloud_ssd",
        "HostMem":"65536",
        "MemoryUsed":"24576",
        "HostStatus":"1",
        "CpuUsed":"10",
        "Engine":"mysql",
        "HostName":"ch-bp15xfnp706tlxxxx",
        "AllocationStatus":"1",
        "ZoneId":"ap-southeast-1a",
        "MemAllocationRatio":"90",
        "VPCId":"vpc-bp1roz55mrbj3ka1sxxxx",
        "VSwitchId":" vsw-bp133c8ifzxd3iv6qxxxx",
        "StorageUsed":"588800",
        "HostClass":"rds.g6.4xlarge",
        "HostCPU":"16",
        "EcsClassCode":"ecs.r5.16xlarge",
        "IPAddress":"192.168.0.56",
        "AccountName":"test"}]},
        "PageSize":"30",
        "RequestId":"D6E068C3-25BC-455A-85FE-45F0B22Exxxx",
        "DedicatedHostGroupId":" dhg-6w7q18iwt5joxxxx",
        "TotalRecords":"3",
        "PageNumbers":"2"}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.RAM User not authorized to operate on the specified resource, or this API does not support RAM. 操作被禁止

访问错误中心查看更多错误码。