DescribeDedicatedHostGroups - 查询专属集群主机组信息_云数据库专属集群(MyBase)-阿里云帮助中心

查询专有集群主机组信息。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可查看地域信息获取。	cn-hangzhou
DedicatedHostGroupId	string	否	专属集群 ID。您可通过云数据库专属集群控制台集群列表查看目标专属集群 ID。该参数为空时，默认返回该地域内所有主机信息。若传入具体的专属集群 ID，则返回该地域该集群内所有主机信息。	dhg-872yt76ann7e****
ImageCategory	string	否	主机镜像。取值： WindowsWithMssqlEntAlwaysonLicense：SQL Server 集群版 WindowsWithMssqlStdLicense：SQL Server 标准版 WindowsWithMssqlEntLicense：SQL Server 企业版 WindowsWithMssqlWebLicense：SQL Server Web 版 AliLinux：其他主机镜像。	AliLinux
Engine	string	否	根据数据库引擎类型过滤主机列表。取值： MySQL SQL Server PosgreSQL Redis	MySQL

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	D6E068C3-25BC-455A-85FE-45F0B22E12SD
DedicatedHostGroups	object []	主机详细信息。
DiskAllocateRation	float	磁盘分配率。	100
DeployType	string	实例部署方式。	origin
CreateTime	string	主机创建时间。	2021-05-07T02:00Z
DedicatedHostCountGroupByHostType	object	不同存储类型对应的主机数量。	2
Text	string	主机描述。	mysql-host
DedicatedHostGroupId	string	主机所属专属集群 ID。	dhg-34639v1jt4y4****
DiskUtility	float	磁盘利用率。	0
MemUsedAmount	float	内存使用量。	0
MemAllocatedAmount	float	内存分配量。	0
CpuAllocationRatio	integer	主机 CPU 超配比。	200
MemAllocationRatio	integer	主机内存超配比。	100
MemAllocateRation	float	分配的内存比例。	9.38
MemUtility	float	内存利用率。	0
CpuAllocatedAmount	float	CPU 申请量。	3
DedicatedHostGroupDesc	string	主机所属专属集群名称。	dhg-34639v1jt4y4****
CpuAllocateRation	float	CPU 申请比例	9.38
InstanceNumber	integer	主机上实例数量。	2
OpenPermission	string	主机 OS 权限。取值： 0、1：关闭 2、3（默认值）：开放说明创建数据库引擎为 MySQL、SQL Server、PostgreSQL 的专属集群时，您可以根据实际需求选择主机开放 OS 权限。	1
VPCId	string	主机所属专属集群专有网络 ID。	vpc-bp1ov7as4yvz4kxei****
DiskAllocatedAmount	float	磁盘分配容量。	1024
HostNumber	integer	主机数量。	2
DiskUsedAmount	float	磁盘使用量。	1024
AllocationPolicy	string	主机资源分配策略，取值： Evenly：均衡分配，最大化追求更稳定的系统表现，优先从未分配资源或已分配资源较少的主机中分配资源。 Intensively：紧凑分配，最大化追求更充分的资源利用率，优先从创建时间较早且已分配资源较多的主机中分配资源。	Evenly
Engine	string	主机数据库引擎类型。	MySQL
DiskAllocationRatio	integer	主机空间超配比。	200
BastionInstanceId	string	主机的主实例 D。若主机上无主实例，则返回空字符串。	rm-bp15rszyxs4t3****
HostReplacePolicy	string	主机故障处理策略。取值： Auto（默认）：自动替换主机。 Manual：手动替换主机。	Auto
ZoneIDList	array	主机可用区列表。
	string	主机可用区列表。	cn-hangzhou-f
Category	string	主机所属的专属集群系列。取值： Pro：MyBase 专有版集群 Standard：MyBase 托管版集群	Pro

示例

正常返回示例

JSON格式

{
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E12SD",
  "DedicatedHostGroups": {
    "DedicatedHostGroups": [
      {
        "DiskAllocateRation": 100,
        "DeployType": "origin",
        "CreateTime": "2021-05-07T02:00Z",
        "DedicatedHostCountGroupByHostType": 2,
        "Text": "mysql-host",
        "DedicatedHostGroupId": " dhg-34639v1jt4y4****",
        "DiskUtility": 0,
        "MemUsedAmount": 0,
        "MemAllocatedAmount": 0,
        "CpuAllocationRatio": 200,
        "MemAllocationRatio": 100,
        "MemAllocateRation": 9.38,
        "MemUtility": 0,
        "CpuAllocatedAmount": 3,
        "DedicatedHostGroupDesc": " dhg-34639v1jt4y4****",
        "CpuAllocateRation": 9.38,
        "InstanceNumber": 2,
        "OpenPermission": "1",
        "VPCId": "vpc-bp1ov7as4yvz4kxei****",
        "DiskAllocatedAmount": 1024,
        "HostNumber": 2,
        "DiskUsedAmount": 1024,
        "AllocationPolicy": "Evenly",
        "Engine": "MySQL",
        "DiskAllocationRatio": 200,
        "BastionInstanceId": "rm-bp15rszyxs4t3****",
        "HostReplacePolicy": "Auto",
        "ZoneIDList": {
          "ZoneIDList": [
            "cn-hangzhou-f"
          ]
        },
        "Category": "Pro"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	Permission.NotSupport	You are not authorized to perform this action.	不允许操作

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