DescribeDedicatedHosts - 查询专属集群的主机信息 - 云数据库专属集群 MyBase

可以来查询专属集群的主机信息。

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
DedicatedHostGroupId	string	是	专属集群 ID。您可以登录云数据库专属集群控制台，在专属集群列表查看并获取专属集群 ID。	dhg-h5i4p331f509****
OrderId	long	否	订单号。您可以前往费用与成本，在左侧导航栏中单击订单管理，在订单列表查看并获取订单号。	123456789
HostType	string	否	主机的存储类型，取值： dhg_local_ssd：本地 SSD 盘。 dhg_cloud_ssd、dhg_cloud_essd：ESSD 云盘。	dhg_cloud_ssd
HostStatus	string	否	主机状态，取值： 0：创建中 1：运行中 2：故障中 3：准备下线 4：维护中 5：已下线 6：重启中 7：锁定中说明当主机出现故障时，主机会下线，下线过程中主机会迁移实例数据。	1
AllocationStatus	string	否	主机是否可分配实例，取值： Allocatable：允许实例分配。 Suspended：停止实例分配。	Allocatable
ZoneId	string	否	可用区 ID。您可以调用 DescribeRegions 接口获取可用区 ID。	ap-southeast-1a
DedicatedHostId	string	否	专属集群的主机 ID，您可以登录云数据库专属集群控制台，在主机列表查看并获取主机 ID。	ch-bp10a5id3boqi****
PageNumbers	integer	否	展示总页码数。	50
PageSize	integer	否	每页展示数目。	20
Tags	string	否	查询绑定有该标签的主机，包括 TagKey 和 TagValue。单次最多支持传入 5 组值，格式：{"key1":"value1","key2":"value2"...}。说明按照主机标签过滤主机信息时，不需要填写 DedicatedHostId 参数，否则会按照 DedicatedHostId 过滤主机信息。	{"key1":"value1"}

返回参数

名称	类型	描述	示例值
	object
TotalRecords	integer	查询返回主机总数目。	40
PageSize	integer	每页展示数目。	20
RequestId	string	请求 ID。	D6E068C3-25BC-455A-85FE-45F0B22EASER
PageNumbers	integer	展示总页码数。	2
DedicatedHostGroupId	string	专属集群 ID。	dhg-6w7q18iwt5jo****
DedicatedHosts	array<object>	主机信息列表。
	object
HostType	string	主机的存储类型。	dhg_cloud_ssd
HostStorage	string	主机的存储总量，单位为 GB。	1234
MemoryUsed	string	内存使用量，单位为 GB。	24576
DedicatedHostGroupId	string	主机所属专属集群 ID。	dhg-6w7q18iwt5jo****
AllocationStatus	string	主机是否可分配实例，取值： Allocatable：允许实例分配 Suspended：停止实例分配	Suspended
StorageUsed	string	存储使用量，单位为 GB。	588800
EcsClassCode	string	ECS 规格代码。更多信息，请参见 ECS 实例规格。	ecs.r5.16xlarge
DedicatedHostId	string	主机 ID。	ch-bp10a5id3boqi****
MemAllocationRatio	string	内存使用率，单位为百分比。	90
CreatedTime	string	主机的创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2020-10-16 16:30:19
IPAddress	string	主机的 IP 地址。	192.168.XX.XX
HostStatus	string	主机状态，取值： 0：创建中 1：运行中 2：故障中 3：准备下线 4：维护中 5：已下线 6：重启中 7：锁定中说明当主机出现故障时，主机会下线，主机下线前主机会迁移实例数据到其他主机上。	1
HostName	string	主机名称。	ch-bp15xfnp706tl****
HostCPU	string	主机 CPU。	16
CpuUsed	string	CPU 使用量，单位为核。	10
InstanceNumber	string	主机上部署的实例数量。	1
OpenPermission	string	主机 OS 权限开放状态。取值： 0：关闭 1（默认值）：开放	1
DistributionSymbol	string	主机分布标识。说明仅主机类型为 Tair 时返回此参数。	0
VPCId	string	主机所属专属集群的专有网络 ID。	vpc-bp1roz55mrbj3ka1s****
HostClass	string	主机规格。	rds.g6.4xlarge
EndTime	string	主机的到期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2021-10-16 16:30:19
VSwitchId	string	主机所在虚拟交换机 ID。	vsw-bp133c8ifzxd3iv6q****
ZoneId	string	主机所在可用区。	ap-southeast-1a
CPUAllocationRatio	string	CPU 使用率.。	10
ImageCategory	string	主机镜像类型。	ALinux
Engine	string	主机的数据库类型。	mysql
DiskAllocationRatio	string	磁盘使用率，单位为百分比。	10
HostMem	string	主机内存，单位 GB。	65536
BastionInstanceId	string	关联的堡垒机 ID。	bastionhost-cn-i7m2fgw****
AccountName	string	自定义主机账号的名称。由小写字母、数字、下划线（_）组成。以字母开头，以字母或数字结尾。最少含 2 个字符，最多含 16 个字符。	test
AccountType	string	主机账号类型，取值： Normal：普通账号 Admin：管理员账号	Normal
DistributionTag	string	主机分布标签。	t4n9uz07h3r1tmcejtxf:1
Category	string	专属集群类型，取值： Pro：MyBase 专有版 Standard：MyBase 托管版说明仅中国站返回此参数。	Standard
EcsId	string	ECS ID。说明仅中国站且专属集群类型为 MyBase 专有版时返回此参数。	i-2zec7l031p0jtru3pn7a
DiskInfo	string	ECS 磁盘信息。说明仅中国站且专属集群类型为 MyBase 专有版时返回此参数。	{\"SystemDiskSize\":20,\"DataDiskCount\":0,\"DataDiskSize\":0,\"DataDiskCategory\":[\"\"],\"SystemDiskCategory\":\"cloud_essd\"}
ChargeType	string	付费类型。	PREPAY
MssqlSupportVersion	string	MyBase SQL Server 主机支持的版本号。	2012_std_ha,2012_std,2016_std_ha,2016_std,2017_std_ha,2017_std,2019_std_ha,2019_std
MaxAutoScaleHostStorage	long	本地盘磁盘自动扩展的上限值，单位 GB。	3661824

示例

正常返回示例

JSON格式

{
  "TotalRecords": 40,
  "PageSize": 20,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22EASER",
  "PageNumbers": 2,
  "DedicatedHostGroupId": "dhg-6w7q18iwt5jo****",
  "DedicatedHosts": {
    "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",
        "MssqlSupportVersion": "2012_std_ha,2012_std,2016_std_ha,2016_std,2017_std_ha,2017_std,2019_std_ha,2019_std"
      }
    ]
  },
  "MaxAutoScaleHostStorage": 3661824
}

错误码

HTTP status code	错误码	错误信息	描述
400	Tag.InvalidTagsParameter	tags parameter is invalid	-
400	InvalidUserId.NotSupport	The userid have no permission.	-
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.	操作被禁止
404	InvalidDedicatedHostGroup.NotFound	Specified DedicatedHostGroup does not exists.	-

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史