调用DescribeDedicatedHostAttribute接口查询专属集群某个主机的参数信息。

专属集群以集群形式批量管理实例,一个地域创建多个集群,一个集群包含多个主机,一个主机包含多个实例,详情请参见什么是云数据库专属集群

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDedicatedHostAttribute

系统规定参数,取值:DescribeDedicatedHostAttribute

DedicatedHostGroupId String dhg-34639v1jt4y4****

专属集群ID。

说明 您可通过云数据库专属集群控制台集群列表查看目标专属集群ID。
DedicatedHostId String ch-bp10a5id3boqi****

主机ID,可调用DescribeDedicatedHosts获取。

RegionId String cn-hangzhou

主机所在地域ID。可查看地域信息获取。

返回数据

名称 类型 示例值 描述
AccountName String test

自定义主机账号的名称。

AccountType String Admin

账号类型,取值:

  • Normal:普通权限账号。
  • Admin:管理员账号。
AllocationStatus String Suspended

主机是否可分配实例,取值:

  • Allocatable:该主机允许分配实例。
  • Suspended:该主机停止分配实例。
AutoRenew String Null

备用参数。

CPUAllocationRatio String 200

专属集群的CPU超配比。

CpuUsed String 2

主机CPU使用量。

CreatedTime String 2021-11-13T07:14:22Z

主机创建成功的时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)

DedicatedHostGroupId String dhg-34639v1jt4y4****

主机所属的专属集群ID。

DedicatedHostId String ch-bp10a5id3boqi****

主机ID。

DiskAllocationRatio String 200

专属集群的空间超配比。

EcsClassCode String ecs.r5.16xlarge

ECS规格代码。

ExpiredTime String 2021-11-13T07:14:22Z

主机到期时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)

HostCPU Integer 16

主机的CPU,单位为核。

HostClass String rds.g6.4xlarge

主机的规格。

HostMem Integer 2048

主机的内存,单位为GB。

HostName String ch-bp15xfnp706tl****

主机的名称。

HostStatus String 1

主机状态,取值:

  • 0:创建中
  • 1:运行中
  • 2:故障中
  • 3:准备下线
  • 4:维护中
  • 5:已下线
  • 6:重启中
  • 7:锁定中
说明 当主机出现故障时,主机要下线,主机下线之前会将该故障主机上的实例进行迁移,从而保证数据的完整性。
HostStorage Integer 100

主机的存储总量,单位为GB。

HostType String dhg_cloud_ssd

主机的存储类型。取值:

  • 本地SSD盘:实例所在物理机的本地存储。该类存储为实例提供块级别的数据访问能力,具有低时延、高随机 IOPS、高吞吐量的 I/O 能力。
  • ESSD云盘:适用于时延敏感的应用或者I/O密集型业务场景。
说明 不同引擎支持的存储类型不同,请以控制台为准。
IPAddress String 192.168.0.56

主机的IP地址。

ImageCategory String WindowsWithMssqlStdLicense

主机镜像。仅在Engine参数为mssql时返回,返回值:

  • WindowsWithMssqlStdLicense:Windows(含SQL Server标准版License)。
  • WindowsWithMssqlEntLisence:Windows(含SQL Server企业版License)。
  • WindowsWithMssqlWebLisence:Windows(含SQL ServerWeb版License)。
InstanceNumber Integer 1

主机上的实例数。

InstanceNumberMaster Integer 1

主机上的主节点数。

InstanceNumberROMaster Integer 1

主机上只读实例的主节点数。

InstanceNumberROSlave Integer 1

主机上只读实例的备节点数。

InstanceNumberSlave Integer 1

主机上的备节点数。

MemAllocationRatio String 90

内存使用率,单位为百分比。

MemoryUsed String 24576

主机内存使用量,单位为GB。

OpenPermission String 1

是否开放专属集群内的主机的OS权限。取值:

  • 0:关闭
  • 1:开放
RegionId String cn-hangzhou

地域ID。

RequestId String D6E068C3-25BC-455A-85FE-45F0B22E1234

请求ID。

StorageUsed String 588800

主机的存储使用量,单位为GB。

VPCId String vpc-bp1roz55mrbj3ka1s****

专有网络的ID。

VSwitchId String vsw-bp133c8ifzxd3iv6q****

虚拟交换机的ID。

ZoneId String cn-hangzhou-e

主机所在可用区ID。

示例

请求示例

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

正常返回示例

XML格式

<DescribeDedicatedHostAttributeReponse>
<CPUAllocationRatio>200</CPUAllocationRatio>
<DiskAllocationRatio>200</DiskAllocationRatio>
<InstanceNumber>1</InstanceNumber>
<DedicatedHostId>ch-bp10a5id3boqi****</DedicatedHostId>
<CreatedTime>2021-11-13T07:14:22Z</CreatedTime>
<DedicatedHostGroupId>dhg-34639v1jt4y4****</DedicatedHostGroupId>
<AutoRenew>Null</AutoRenew>
<ImageCategory>WindowsWithMssqlStdLicense</ImageCategory>
<HostStorage>100</HostStorage>
<InstanceNumberSlave>1</InstanceNumberSlave>
<OpenPermission>1</OpenPermission>
<HostType>dhg_cloud_ssd</HostType>
<ExpiredTime>2021-11-13T07:14:22Z</ExpiredTime>
<HostMem>2048</HostMem>
<MemoryUsed>24576</MemoryUsed>
<HostStatus>1</HostStatus>
<CpuUsed>2</CpuUsed>
<HostName>ch-bp15xfnp706tl****</HostName>
<InstanceNumberROSlave>1</InstanceNumberROSlave>
<AllocationStatus>Suspended</AllocationStatus>
<ZoneId>cn-hangzhou-e</ZoneId>
<RequestId>D6E068C3-25BC-455A-85FE-45F0B22E1234</RequestId>
<MemAllocationRatio>90</MemAllocationRatio>
<VPCId>vpc-bp1roz55mrbj3ka1s****</VPCId>
<InstanceNumberROMaster>1</InstanceNumberROMaster>
<VSwitchId> vsw-bp133c8ifzxd3iv6q****</VSwitchId>
<AccountType>Admin</AccountType>
<InstanceNumberMaster>1</InstanceNumberMaster>
<StorageUsed>588800</StorageUsed>
<HostClass>rds.g6.4xlarge</HostClass>
<HostCPU>16</HostCPU>
<EcsClassCode>ecs.r5.16xlarge</EcsClassCode>
<RegionId>cn-hangzhou</RegionId>
<IPAddress>192.168.0.56</IPAddress>
<AccountName>test</AccountName>
<DescribeDedicatedHostAttributeReponse>

JSON格式

{
    "CPUAllocationRatio": "200",
    "DiskAllocationRatio": "200",
    "InstanceNumber": "1",
    "DedicatedHostId": "ch-bp10a5id3boqi****",
    "CreatedTime": "2021-11-13T07:14:22Z",
    "DedicatedHostGroupId": "dhg-34639v1jt4y4****",
    "AutoRenew": "Null",
    "ImageCategory": "WindowsWithMssqlStdLicense",
    "HostStorage": "100",
    "InstanceNumberSlave": "1",
    "OpenPermission": "1",
    "HostType": "dhg_cloud_ssd",
    "ExpiredTime": "2021-11-13T07:14:22Z",
    "HostMem": "2048",
    "MemoryUsed": "24576",
    "HostStatus": "1",
    "CpuUsed": "2",
    "HostName": "ch-bp15xfnp706tl****",
    "InstanceNumberROSlave": "1",
    "AllocationStatus": "Suspended",
    "ZoneId": "cn-hangzhou-e",
    "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E1234",
    "MemAllocationRatio": "90",
    "VPCId": "vpc-bp1roz55mrbj3ka1s****",
    "InstanceNumberROMaster": "1",
    "VSwitchId": " vsw-bp133c8ifzxd3iv6q****",
    "AccountType": "Admin",
    "InstanceNumberMaster": "1",
    "StorageUsed": "588800",
    "HostClass": "rds.g6.4xlarge",
    "HostCPU": "16",
    "EcsClassCode": "ecs.r5.16xlarge",
    "RegionId": "cn-hangzhou",
    "IPAddress": "192.168.0.56",
    "AccountName": "test"
}

错误码

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

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