DescribeDedicatedHosts查询专属集群下的主机信息_云数据库专属集群 MyBase-阿里云帮助中心

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

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDedicatedHosts	系统规定参数。取值：DescribeDedicatedHosts。
RegionId	String	是	cn-hangzhou	地域ID。
DedicatedHostGroupId	String	是	dhg-h5i4p331f509****	专属集群ID。您可以登录云数据库专属集群控制台，在专属集群列表查看并获取专属集群ID。
OrderId	Long	否	123456789	订单号。您可以登录用户中心，在订单列表查看并获取订单号。
HostType	String	否	dhg_cloud_ssd	主机的存储类型，取值： dhg_local_ssd：本地SSD盘 dhg_cloud_ssd、dhg_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。您可以调用DescribeRegions接口获取可用区ID。
DedicatedHostId	String	否	ch-bp10a5id3boqi****	专属集群的主机ID，您可以登录云数据库专属集群控制台，在主机列表查看并获取主机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
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.XX.XX	主机的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	1	主机OS权限开放状态。取值： 0：关闭 1（默认值）：开放
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	主机内存，单位GB。
BastionInstanceId	String	bastionhost-cn-i7m2fgw****	关联的堡垒机ID。
AccountName	String	test	自定义主机账号的名称。由小写字母、数字、下划线（_）组成。以字母开头，以字母或数字结尾。最少含2个字符，最多含16个字符。
AccountType	String	Normal	主机账号类型，取值： Normal：普通账号 Admin：管理员账号
DistributionTag	String	t4n9uz07h3r1tmcejtxf:1	主机分布标签。
Category	String	Standard	专属集群类型，取值： Pro：MyBase专有版 Standard：MyBase托管版说明仅中国站返回此参数。
EcsId	String	i-2zec7l031p0jtru3pn7a	ECS ID。说明仅中国站且专属集群类型为MyBase专有版时返回此参数。
DiskInfo	String	{\"SystemDiskSize\":20,\"DataDiskCount\":0,\"DataDiskSize\":0,\"DataDiskCategory\":[\"\"],\"SystemDiskCategory\":\"cloud_essd\"}	ECS磁盘信息。说明仅中国站且专属集群类型为MyBase专有版时返回此参数。
ChargeType	String	PREPAY	付费类型。
MssqlSupportVersion	String	2012_std_ha,2012_std,2016_std_ha,2016_std,2017_std_ha,2017_std,2019_std_ha,2019_std	MyBase SQL Server主机支持的版本号。
MaxAutoScaleHostStorage	Long	3661824	本地盘磁盘自动扩展的上限值，单位GB。

示例

请求示例

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
&公共请求参数

正常返回示例

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>
        <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.XX.XX</IPAddress>
        <HostStatus>1</HostStatus>
        <HostName>ch-bp15xfnp706tl****</HostName>
        <HostCPU>16</HostCPU>
        <CpuUsed>10</CpuUsed>
        <InstanceNumber>1</InstanceNumber>
        <OpenPermission>1</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>t4n9uz07h3r1tmcejtxf:1</DistributionTag>
        <Category>Standard</Category>
        <EcsId>i-2zec7l031p0jtru3pn7a</EcsId>
        <DiskInfo>{\"SystemDiskSize\":20,\"DataDiskCount\":0,\"DataDiskSize\":0,\"DataDiskCategory\":[\"\"],\"SystemDiskCategory\":\"cloud_essd\"}</DiskInfo>
        <ChargeType>PREPAY</ChargeType>
    </DedicatedHosts>
    <MaxAutoScaleHostStorage>3661824</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" : [ {
    "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.XX.XX",
    "HostStatus" : "1",
    "HostName" : "ch-bp15xfnp706tl****",
    "HostCPU" : "16",
    "CpuUsed" : "10",
    "InstanceNumber" : "1",
    "OpenPermission" : "1",
    "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" : "t4n9uz07h3r1tmcejtxf:1",
    "Category" : "Standard",
    "EcsId" : "i-2zec7l031p0jtru3pn7a",
    "DiskInfo" : "{\\\"SystemDiskSize\\\":20,\\\"DataDiskCount\\\":0,\\\"DataDiskSize\\\":0,\\\"DataDiskCategory\\\":[\\\"\\\"],\\\"SystemDiskCategory\\\":\\\"cloud_essd\\\"}",
    "ChargeType" : "PREPAY"
  } ],
  "MaxAutoScaleHostStorage" : 3661824
}

错误码


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

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