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

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

调试

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

请求参数

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

系统规定参数，取值：DescribeDedicatedHosts。

DedicatedHostGroupId String 是 dhg-h5i4p331f509****

专属集群ID。

说明 您可通过云数据库专属集群控制台集群列表查看目标专属集群ID。
RegionId String 是 cn-hangzhou

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

OrderId Long 否 123456789

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

主机的存储类型，取值：

  • dhg_cloud_ssd：本地SSD盘。
  • dhg_cloud_ssd：ESSD云盘。
AllocationStatus String 否 Allocatable

主机是否可分配实例，取值：

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

主机状态，取值：

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

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

DedicatedHostId String 否 ch-bp10a5id3boqi****

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

PageNumbers Integer 否 50

展示总页码数。
PageSize Integer 否 20

每页展示数目。

返回数据

名称 类型 示例值 描述
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。
CPUAllocationRatio String 10

CPU使用率.。
CpuUsed String 10

CPU使用量，单位为核。
CreatedTime String 2020-10-16 16:30:19

主机的创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

DedicatedHostGroupId String dhg-6w7q18iwt5jo****

主机所属专属集群ID。
DedicatedHostId String ch-bp10a5id3boqi****

主机ID。
DeployType String Basic

部署方式。仅MySQL类型的主机返回此参数，取值为：High-availability、Basic。

DiskAllocationRatio String 10

磁盘使用率，单位为百分比。
EcsClassCode String ecs.r5.16xlarge

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

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

主机的到期时间，格式为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 1234

主机的存储总量，单位为GB。
HostType String dhg_cloud_ssd

主机的存储类型。
IPAddress String 192.168.0.56

主机的IP地址。
ImageCategory String ALinux

主机镜像类型。
InstanceNumber String 1

主机上的实例数。
MemAllocationRatio String 90

内存使用率，单位为百分比。
MemoryUsed String 24576

内存使用量，单位为GB。
OpenPermission String 0

主机OS权限开放状态。
StorageUsed String 588800

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

VPCId String vpc-bp1roz55mrbj3ka1s****

主机所属专属集群的专有网ID。
VSwitchId String vsw-bp133c8ifzxd3iv6qxxxx

主机所在虚拟交换机ID。
ZoneId String ap-southeast-1a

主机所在可用区。
PageNumbers Integer 2

展示总页码数。
PageSize Integer 20

每页展示数目。
RequestId String D6E068C3-25BC-455A-85FE-45F0B22EASER

请求ID。
TotalRecords Integer 40

查询返回主机总数目。

示例

请求示例

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

正常返回示例

XML格式 

<DescribeDedicatedHostsReponse>
  <DedicatedHosts>
        <DedicatedHosts>
              <DeployType>Basic</DeployType>
              <CPUAllocationRatio>10</CPUAllocationRatio>
              <DiskAllocationRatio>10</DiskAllocationRatio>
              <InstanceNumber>1</InstanceNumber>
              <DedicatedHostId>ch-bp10a5id3boqi****</DedicatedHostId>
              <CreatedTime>2020-10-16 16:30:19</CreatedTime>
              <EndTime>2021-10-16 16:30:19</EndTime>
              <DedicatedHostGroupId> dhg-6w7q18iwt5jo****</DedicatedHostGroupId>
              <BastionInstanceId>bastionhost-cn-xxxxxxxxxxx</BastionInstanceId>
              <ImageCategory>ALinux</ImageCategory>
              <HostStorage>1234</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>Suspended</AllocationStatus>
              <ZoneId>ap-southeast-1a</ZoneId>
              <MemAllocationRatio>90</MemAllocationRatio>
              <VPCId>vpc-bp1roz55mrbj3ka1s****</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>20</PageSize>
  <RequestId>D6E068C3-25BC-455A-85FE-45F0B22EASER</RequestId>
  <DedicatedHostGroupId> dhg-6w7q18iwt5jo****</DedicatedHostGroupId>
  <TotalRecords>40</TotalRecords>
  <PageNumbers>2</PageNumbers>
</DescribeDedicatedHostsReponse>

JSON格式 

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

错误码

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

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