DescribeDedicatedHostAttribute - 云数据库专属集群 MyBase

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDedicatedHostAttribute	系统规定参数。取值：DescribeDedicatedHostAttribute。
RegionId	String	否	cn-hangzhou	地域ID。
DedicatedHostId	String	是	ch-bp10a5id3boqi****	主机ID。您可以登录云数据库专属集群控制台，在主机列表查看并获取主机ID。
DedicatedHostGroupId	String	是	dhg-34639v1jt4y4****	主机所属集群的ID。您可以登录云数据库专属集群控制台，在集群列表查看并获取专属集群ID。

返回数据


名称	类型	示例值	描述
HostType	String	dhg_cloud_ssd	主机的存储类型，取值： dhg_cloud_ssd、dhg_cloud_essd：ESSD云盘 dhg_local_ssd：本地SSD盘
HostStorage	Integer	100	主机的存储总量，单位为GB。
InstanceNumberROSlave	Integer	1	主机上只读实例的备节点数。
AccountType	String	Admin	账号类型，取值： Normal：普通权限账号 Admin：管理员账号
MemoryUsed	String	24576	主机内存使用量，单位为GB。
DedicatedHostGroupId	String	dhg-34639v1jt4y4****	主机所属集群的ID。
RequestId	String	00A001D6-2630-5CBD-A23C-80BC1BAFDC31	请求ID。
InstanceNumberROMaster	Integer	1	主机上只读实例的主节点数。
AllocationStatus	String	Suspended	主机是否可分配实例，取值： Allocatable：允许分配实例 Suspended：停止分配实例
StorageUsed	String	588800	主机的存储使用量，单位为GB。
EcsClassCode	String	ecs.r5.16xlarge	ECS规格代码。
DedicatedHostId	String	ch-bp10a5id3boqi****	主机ID。
MemAllocationRatio	String	90	内存使用率，单位为百分比。
CreatedTime	String	2021-11-13T07:14:22Z	主机创建成功的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
IPAddress	String	192.168.XX.XX	主机的IP地址。
AutoRenew	String	false	是否开启自动续费功能，取值： true：开启 false（默认值）：不开启
HostStatus	String	1	主机状态，取值： 0：创建中 1：运行中 2：故障中 3：准备下线 4：维护中 5：已下线 6：重启中 7：锁定中说明当主机出现故障时，主机要下线，主机下线之前会将该故障主机上的实例进行迁移，从而保证数据的完整性。
HostName	String	ch-8vbj9x74z874o****	主机的名称。
HostCPU	Integer	16	主机的CPU，单位为核。
OpenPermission	String	1	是否开放专属集群内的主机的OS权限，取值： 0：不可开放状态 1：开放状态
InstanceNumber	Integer	3	主机上部署实例的个数。
CpuUsed	String	36	主机CPU使用量。
VPCId	String	vpc-wz9vu1jb32wn3sdd6****	专有网络的ID。
HostClass	String	mssql.host.c2xlarge	主机的规格。
RegionId	String	cn-hangzhou	地域ID。
InstanceNumberMaster	Integer	4	主机上的主节点数。
VSwitchId	String	vsw-bp1kaugqyrzb58oc1****	VSwitch ID。
InstanceNumberSlave	Integer	1	主机上的备节点数。
ExpiredTime	String	2022-03-16T16:00:00Z	主机到期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
ZoneId	String	cn-hangzhou-h	可用区ID。
CPUAllocationRatio	String	200	专属集群的cpu超配比，单位为百分比，精确到10%。
ImageCategory	String	WindowsWithMssqlStdLicense	主机镜像。引擎类型为SQL Server时返回，取值： WindowsWithMssqlEntAlwaysonLicense：SQL Server集群版 WindowsWithMssqlStdLicense：SQL Server标准版 WindowsWithMssqlEntLicense：SQL Server企业版 WindowsWithMssqlWebLicense：SQL Server Web版
DiskAllocationRatio	String	200	专属集群的空间超配比。
HostMem	Integer	2048	主机的内存，单位为MB。
AccountName	String	cdp_system	主机账号名称。由小写字母、数字、下划线（_）组成。以字母开头，以字母或数字结尾。包含2~16个字符。
DistributionTag	String	tag	主机分布的标签。

示例

请求示例

http(s)://cddc.aliyuncs.com/?Action=DescribeDedicatedHostAttribute
&RegionId=cn-hangzhou
&DedicatedHostId=ch-bp10a5id3boqi****
&DedicatedHostGroupId=dhg-34639v1jt4y4****
&公共请求参数

正常返回示例

XML格式

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

<DescribeDedicatedHostAttributeResponse>
    <HostType>dhg_cloud_ssd</HostType>
    <HostStorage>100</HostStorage>
    <InstanceNumberROSlave>1</InstanceNumberROSlave>
    <AccountType>Admin</AccountType>
    <MemoryUsed>24576</MemoryUsed>
    <DedicatedHostGroupId>dhg-34639v1jt4y4****</DedicatedHostGroupId>
    <RequestId>00A001D6-2630-5CBD-A23C-80BC1BAFDC31</RequestId>
    <InstanceNumberROMaster>1</InstanceNumberROMaster>
    <AllocationStatus>Suspended</AllocationStatus>
    <StorageUsed>588800</StorageUsed>
    <EcsClassCode>ecs.r5.16xlarge</EcsClassCode>
    <DedicatedHostId>ch-bp10a5id3boqi****</DedicatedHostId>
    <MemAllocationRatio>90</MemAllocationRatio>
    <CreatedTime>2021-11-13T07:14:22Z</CreatedTime>
    <IPAddress>192.168.XX.XX</IPAddress>
    <AutoRenew>false</AutoRenew>
    <HostStatus>1</HostStatus>
    <HostName>ch-8vbj9x74z874o****</HostName>
    <HostCPU>16</HostCPU>
    <OpenPermission>1</OpenPermission>
    <InstanceNumber>3</InstanceNumber>
    <CpuUsed>36</CpuUsed>
    <VPCId>vpc-wz9vu1jb32wn3sdd6****</VPCId>
    <HostClass>mssql.host.c2xlarge</HostClass>
    <RegionId>cn-hangzhou</RegionId>
    <InstanceNumberMaster>4</InstanceNumberMaster>
    <VSwitchId>vsw-bp1kaugqyrzb58oc1****</VSwitchId>
    <InstanceNumberSlave>1</InstanceNumberSlave>
    <ExpiredTime>2022-03-16T16:00:00Z</ExpiredTime>
    <ZoneId>cn-hangzhou-h</ZoneId>
    <CPUAllocationRatio>200</CPUAllocationRatio>
    <ImageCategory>WindowsWithMssqlStdLicense</ImageCategory>
    <DiskAllocationRatio>200</DiskAllocationRatio>
    <HostMem>2048</HostMem>
    <AccountName>cdp_system</AccountName>
    <DistributionTag>tag</DistributionTag>
</DescribeDedicatedHostAttributeResponse>

JSON格式

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

{
  "HostType" : "dhg_cloud_ssd",
  "HostStorage" : 100,
  "InstanceNumberROSlave" : 1,
  "AccountType" : "Admin",
  "MemoryUsed" : "24576",
  "DedicatedHostGroupId" : "dhg-34639v1jt4y4****",
  "RequestId" : "00A001D6-2630-5CBD-A23C-80BC1BAFDC31",
  "InstanceNumberROMaster" : 1,
  "AllocationStatus" : "Suspended",
  "StorageUsed" : "588800",
  "EcsClassCode" : "ecs.r5.16xlarge",
  "DedicatedHostId" : "ch-bp10a5id3boqi****",
  "MemAllocationRatio" : "90",
  "CreatedTime" : "2021-11-13T07:14:22Z",
  "IPAddress" : "192.168.XX.XX",
  "AutoRenew" : "false",
  "HostStatus" : "1",
  "HostName" : "ch-8vbj9x74z874o****",
  "HostCPU" : 16,
  "OpenPermission" : "1",
  "InstanceNumber" : 3,
  "CpuUsed" : "36",
  "VPCId" : "vpc-wz9vu1jb32wn3sdd6****",
  "HostClass" : "mssql.host.c2xlarge",
  "RegionId" : "cn-hangzhou",
  "InstanceNumberMaster" : 4,
  "VSwitchId" : "vsw-bp1kaugqyrzb58oc1****",
  "InstanceNumberSlave" : 1,
  "ExpiredTime" : "2022-03-16T16:00:00Z",
  "ZoneId" : "cn-hangzhou-h",
  "CPUAllocationRatio" : "200",
  "ImageCategory" : "WindowsWithMssqlStdLicense",
  "DiskAllocationRatio" : "200",
  "HostMem" : 2048,
  "AccountName" : "cdp_system",
  "DistributionTag" : "tag"
}

错误码


HttpCode	错误码	错误信息	描述
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.	操作被禁止
403	Permission.NotSupport	The user permission does not support the operation.	权限不支持当前操作

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