DescribeDedicatedHostGroups - 云数据库专属集群 MyBase

调试

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

请求参数


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

返回数据


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

示例

请求示例

http(s)://cddc.aliyuncs.com/?Action=DescribeDedicatedHostGroups
&RegionId=cn-hangzhou
&DedicatedHostGroupId=dhg-872yt76ann7e****
&ImageCategory=ESSD
&Engine=mysql
&公共请求参数

正常返回示例

XML格式

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

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

JSON格式

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

{
  "RequestId" : "D6E068C3-25BC-455A-85FE-45F0B22E12SD",
  "DedicatedHostGroups" : {
    "DiskAllocateRation" : 100,
    "DeployType" : "origin",
    "CreateTime" : "2021-05-07T02:00Z",
    "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" : "cn-hangzhou-f"
  }
}

错误码


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

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