全部产品
Search

搜索本产品

    云数据库专属集群 MyBase：DescribeDedicatedHostAttribute - 查询专属集群某个主机的参数信息

    文档中心

    云数据库专属集群 MyBase：DescribeDedicatedHostAttribute - 查询专属集群某个主机的参数信息

    更新时间：Aug 28, 2026

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

    调试

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

    调试

    授权信息

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

    请求参数

    名称

    类型

    必填

    描述

    示例值
    RegionId

    string

    否

    地域 ID。

    cn-hangzhou
    DedicatedHostId

    string

    是

    主机 ID。您可以登录云数据库专属集群控制台，在主机列表查看并获取主机 ID。

    ch-bp10a5id3boqi****
    DedicatedHostGroupId

    string

    是

    主机所属集群的 ID。您可以登录云数据库专属集群控制台，在集群列表查看并获取专属集群 ID。

    dhg-34639v1jt4y4****

    返回参数

    名称

    类型

    描述

    示例值

    object

    HostType

    string

    主机的存储类型，取值：

    • dhg_cloud_ssd、dhg_cloud_essd：ESSD 云盘

    • dhg_local_ssd：本地 SSD 盘

    dhg_cloud_ssd
    HostStorage

    integer

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

    100
    InstanceNumberROSlave

    integer

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

    1
    AccountType

    string

    账号类型，取值：

    • Normal：普通权限账号

    • Admin：管理员账号

    Admin
    MemoryUsed

    string

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

    24576
    DedicatedHostGroupId

    string

    主机所属集群的 ID。

    dhg-34639v1jt4y4****
    RequestId

    string

    请求 ID。

    00A001D6-2630-5CBD-A23C-80BC1BAFDC31
    InstanceNumberROMaster

    integer

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

    1
    AllocationStatus

    string

    主机是否可分配实例，取值：

    • Allocatable：允许分配实例

    • Suspended：停止分配实例

    Suspended
    StorageUsed

    string

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

    588800
    EcsClassCode

    string

    ECS 规格代码。

    ecs.r5.16xlarge
    DedicatedHostId

    string

    主机 ID。

    ch-bp10a5id3boqi****
    MemAllocationRatio

    string

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

    90
    CreatedTime

    string

    主机创建成功的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    2021-11-13T07:14:22Z
    IPAddress

    string

    主机的 IP 地址。

    192.168.XX.XX
    AutoRenew

    string

    是否开启自动续费功能，取值：

    • true：开启

    • false（默认值）：不开启

    false
    HostStatus

    string

    主机状态，取值：

    • 0：创建中

    • 1：运行中

    • 2：故障中

    • 3：准备下线

    • 4：维护中

    • 5：已下线

    • 6：重启中

    • 7：锁定中

    说明

    当主机出现故障时，主机要下线，主机下线之前会将该故障主机上的实例进行迁移，从而保证数据的完整性。

    1
    HostName

    string

    主机的名称。

    ch-8vbj9x74z874o****
    HostCPU

    integer

    主机的 CPU，单位为核。

    16
    OpenPermission

    string

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

    • 0：不可开放状态

    • 1：开放状态

    1
    InstanceNumber

    integer

    主机上部署实例的个数。

    3
    CpuUsed

    string

    主机 CPU 使用量。

    36
    VPCId

    string

    专有网络的 ID。

    vpc-wz9vu1jb32wn3sdd6****
    HostClass

    string

    主机的规格。

    mssql.host.c2xlarge
    RegionId

    string

    地域 ID。

    cn-hangzhou
    InstanceNumberMaster

    integer

    主机上的主节点数。

    4
    VSwitchId

    string

    VSwitch ID。

    vsw-bp1kaugqyrzb58oc1****
    InstanceNumberSlave

    integer

    主机上的备节点数。

    1
    ExpiredTime

    string

    主机到期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    2022-03-16T16:00:00Z
    ZoneId

    string

    可用区 ID。

    cn-hangzhou-h
    CPUAllocationRatio

    string

    专属集群的 cpu 超配比，单位为百分比，精确到 10%。

    200
    ImageCategory

    string

    主机镜像。引擎类型为SQL Server时返回，取值：

    • WindowsWithMssqlEntAlwaysonLicense：SQL Server 集群版

    • WindowsWithMssqlStdLicense：SQL Server 标准版

    • WindowsWithMssqlEntLicense：SQL Server 企业版

    • WindowsWithMssqlWebLicense：SQL Server Web 版

    WindowsWithMssqlStdLicense
    DiskAllocationRatio

    string

    专属集群的空间超配比。

    200
    HostMem

    integer

    主机的内存，单位为 MB。

    2048
    AccountName

    string

    主机账号名称。

    • 由小写字母、数字、下划线（_）组成。

    • 以字母开头，以字母或数字结尾。

    • 包含 2~16 个字符。

    cdp_system
    DistributionTag

    string

    主机分布的标签。

    tag

    示例

    正常返回示例

    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"
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    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. 操作被禁止
    403 Permission.NotSupport The user permission does not support the operation. 权限不支持当前操作
    404 InvalidDedicatedHostGroup.NotFound Specified DedicatedHostGroup does not exists.

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

    变更历史

    更多信息，参考变更详情。