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

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

调试

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

请求参数

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

系统规定参数。取值:DescribeDedicatedHosts

RegionId String cn-hangzhou

地域ID。可查看地域信息获取。

DedicatedHostGroupId String dhg-h5i4p331f509****

专属集群ID。

说明 您可通过云数据库专属集群控制台集群列表查看目标专属集群ID。
OrderId Long 123456789

订单ID。可在专属集群控制台订单-订单列表中查看。

HostType String dhg_cloud_ssd

主机的存储类型,取值:

  • dhg_local_ssd:本地SSD盘。
  • dhg_cloud_ssddhg_cloud_essd:ESSD云盘。
HostStatus String 1

主机状态,取值:

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

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

  • Allocatable:该主机允许实例分配。
  • Suspended:该主机停止实例分配。
ZoneId String ap-southeast-1a

可用区ID。可调用地域信息获取。

DedicatedHostId String ch-bp10a5id3boqi****

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

PageNumbers Integer 50

展示总页码数。

PageSize Integer 20

每页展示数目。

Tags String {"key1":"value1"}

查询绑定有该标签的主机,包括TagKey和TagValue。单次最多支持传入5组值,格式:{"key1":"value1","key2":"value2"...}。

说明 按照主机标签过滤主机信息时,不需要填写DedicatedHostId参数,否则会按照DedicatedHostId过滤主机信息。

返回数据

名称 类型 示例值 描述
TotalRecords Integer 40

查询返回主机总数目。

PageSize Integer 20

每页展示数目。

RequestId String D6E068C3-25BC-455A-85FE-45F0B22EASER

请求ID。

PageNumbers Integer 2

展示总页码数。

DedicatedHostGroupId String dhg-6w7q18iwt5jo****

专属集群ID。

DedicatedHosts Array of DedicatedHosts

主机信息列表。

DedicatedHosts
DeployType String Basic

部署方式。仅MySQL类型的主机返回此参数,取值:

  • High-availability
  • Basic
HostType String dhg_cloud_ssd

主机的存储类型。

HostStorage String 1234

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

MemoryUsed String 24576

内存使用量,单位为GB。

DedicatedHostGroupId String dhg-6w7q18iwt5jo****

主机所属专属集群ID。

AllocationStatus String Suspended

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

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

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

EcsClassCode String ecs.r5.16xlarge

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

DedicatedHostId String ch-bp10a5id3boqi****

主机ID。

MemAllocationRatio String 90

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

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

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

IPAddress String 192.168.0.56

主机的IP地址。

HostStatus String 1

主机状态,取值:

  • 0:创建中
  • 1:运行中
  • 2:故障中
  • 3:准备下线
  • 4:维护中
  • 5:已下线
  • 6:重启中
  • 7:锁定中
说明 当主机出现故障时,主机会下线;主机下线前,主机会迁移实例数据到其他主机上。
HostName String ch-bp15xfnp706tl****

主机名称。

HostCPU String 16

主机CPU。

CpuUsed String 10

CPU使用量,单位为核。

InstanceNumber String 1

主机上的实例数。

OpenPermission String 0

主机OS权限开放状态。

DistributionSymbol String 0

主机分布标识,仅Tair主机生效。

VPCId String vpc-bp1roz55mrbj3ka1s****

主机所属专属集群的专有网ID。

HostClass String rds.g6.4xlarge

主机规格。

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

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

VSwitchId String vsw-bp133c8ifzxd3iv6q****

主机所在虚拟交换机ID。

ZoneId String ap-southeast-1a

主机所在可用区。

CPUAllocationRatio String 10

CPU使用率.。

ImageCategory String ALinux

主机镜像类型。

Engine String mysql

主机数据库引擎类型。

DiskAllocationRatio String 10

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

HostMem String 65536

主机内存。

BastionInstanceId String bastionhost-cn-i7m2fgw****

关联的堡垒机ID。

AccountName String test

自定义主机账号的名称。

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

主机账号类型,取值:

Normal:普通账号

Admin:管理员账号

DistributionTag String t4n9uz07h3r1tmce****:1

主机分布标签。

MaxAutoScaleHostStorage Long 0

本地盘磁盘自动扩展的上限值。

示例

请求示例

http(s)://cddc.aliyuncs.com/?Action=DescribeDedicatedHosts
&RegionId=cn-hangzhou
&DedicatedHostGroupId=dhg-h5i4p331f509****
&OrderId=123456789
&HostType=dhg_cloud_ssd
&HostStatus=1
&AllocationStatus=Allocatable
&ZoneId=ap-southeast-1a
&DedicatedHostId=ch-bp10a5id3boqi****
&PageNumbers=50
&PageSize=20
&Tags={"key1":"value1"}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDedicatedHostsResponse>
    <TotalRecords>40</TotalRecords>
    <PageSize>20</PageSize>
    <RequestId>D6E068C3-25BC-455A-85FE-45F0B22EASER</RequestId>
    <PageNumbers>2</PageNumbers>
    <DedicatedHostGroupId>dhg-6w7q18iwt5jo****</DedicatedHostGroupId>
    <DedicatedHosts>
        <DeployType>Basic</DeployType>
        <HostType>dhg_cloud_ssd</HostType>
        <HostStorage>1234</HostStorage>
        <MemoryUsed>24576</MemoryUsed>
        <DedicatedHostGroupId>dhg-6w7q18iwt5jo****</DedicatedHostGroupId>
        <AllocationStatus>Suspended</AllocationStatus>
        <StorageUsed>588800</StorageUsed>
        <EcsClassCode>ecs.r5.16xlarge</EcsClassCode>
        <DedicatedHostId>ch-bp10a5id3boqi****</DedicatedHostId>
        <MemAllocationRatio>90</MemAllocationRatio>
        <CreatedTime>2020-10-16 16:30:19</CreatedTime>
        <IPAddress>192.168.0.56</IPAddress>
        <HostStatus>1</HostStatus>
        <HostName>ch-bp15xfnp706tl****</HostName>
        <HostCPU>16</HostCPU>
        <CpuUsed>10</CpuUsed>
        <InstanceNumber>1</InstanceNumber>
        <OpenPermission>0</OpenPermission>
        <DistributionSymbol>0</DistributionSymbol>
        <VPCId>vpc-bp1roz55mrbj3ka1s****</VPCId>
        <HostClass>rds.g6.4xlarge</HostClass>
        <EndTime>2021-10-16 16:30:19</EndTime>
        <VSwitchId>vsw-bp133c8ifzxd3iv6q****</VSwitchId>
        <ZoneId>ap-southeast-1a</ZoneId>
        <CPUAllocationRatio>10</CPUAllocationRatio>
        <ImageCategory>ALinux</ImageCategory>
        <Engine>mysql</Engine>
        <DiskAllocationRatio>10</DiskAllocationRatio>
        <HostMem>65536</HostMem>
        <BastionInstanceId>bastionhost-cn-i7m2fgw****</BastionInstanceId>
        <AccountName>test</AccountName>
        <AccountType>Normal</AccountType>
        <DistributionTag>t4n9uz07h3r1tmce****:1</DistributionTag>
    </DedicatedHosts>
    <MaxAutoScaleHostStorage>0</MaxAutoScaleHostStorage>
</DescribeDedicatedHostsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecords" : 40,
  "PageSize" : 20,
  "RequestId" : "D6E068C3-25BC-455A-85FE-45F0B22EASER",
  "PageNumbers" : 2,
  "DedicatedHostGroupId" : "dhg-6w7q18iwt5jo****",
  "DedicatedHosts" : [ {
    "DeployType" : "Basic",
    "HostType" : "dhg_cloud_ssd",
    "HostStorage" : "1234",
    "MemoryUsed" : "24576",
    "DedicatedHostGroupId" : "dhg-6w7q18iwt5jo****",
    "AllocationStatus" : "Suspended",
    "StorageUsed" : "588800",
    "EcsClassCode" : "ecs.r5.16xlarge",
    "DedicatedHostId" : "ch-bp10a5id3boqi****",
    "MemAllocationRatio" : "90",
    "CreatedTime" : "2020-10-16 16:30:19",
    "IPAddress" : "192.168.0.56",
    "HostStatus" : "1",
    "HostName" : "ch-bp15xfnp706tl****",
    "HostCPU" : "16",
    "CpuUsed" : "10",
    "InstanceNumber" : "1",
    "OpenPermission" : "0",
    "DistributionSymbol" : "0",
    "VPCId" : "vpc-bp1roz55mrbj3ka1s****",
    "HostClass" : "rds.g6.4xlarge",
    "EndTime" : "2021-10-16 16:30:19",
    "VSwitchId" : "vsw-bp133c8ifzxd3iv6q****",
    "ZoneId" : "ap-southeast-1a",
    "CPUAllocationRatio" : "10",
    "ImageCategory" : "ALinux",
    "Engine" : "mysql",
    "DiskAllocationRatio" : "10",
    "HostMem" : "65536",
    "BastionInstanceId" : "bastionhost-cn-i7m2fgw****",
    "AccountName" : "test",
    "AccountType" : "Normal",
    "DistributionTag" : "t4n9uz07h3r1tmce****:1"
  } ],
  "MaxAutoScaleHostStorage" : 0
}

错误码

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

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