全部产品
Search

搜索本产品

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

    文档中心

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

    更新时间：Aug 28, 2024

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

    调试

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

    授权信息

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

    请求参数

    名称类型必填描述示例值
    RegionIdstring否

    地域 ID。

    		cn-hangzhou
    DedicatedHostIdstring是

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

    		ch-bp10a5id3boqi****
    DedicatedHostGroupIdstring是

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

    		dhg-34639v1jt4y4****

    返回参数

    名称类型描述示例值
    object
    HostTypestring

    主机的存储类型，取值：

    • dhg_cloud_ssd、dhg_cloud_essd：ESSD 云盘

    • dhg_local_ssd：本地 SSD 盘

    		dhg_cloud_ssd
    HostStorageinteger

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

    		100
    InstanceNumberROSlaveinteger

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

    		1
    AccountTypestring

    账号类型，取值：

    • Normal：普通权限账号
    • Admin：管理员账号
    		Admin
    MemoryUsedstring

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

    		24576
    DedicatedHostGroupIdstring

    主机所属集群的 ID。

    		dhg-34639v1jt4y4****
    RequestIdstring

    请求 ID。

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

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

    		1
    AllocationStatusstring

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

    • Allocatable：允许分配实例
    • Suspended：停止分配实例
    		Suspended
    StorageUsedstring

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

    		588800
    EcsClassCodestring

    ECS 规格代码。

    		ecs.r5.16xlarge
    DedicatedHostIdstring

    主机 ID。

    		ch-bp10a5id3boqi****
    MemAllocationRatiostring

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

    		90
    CreatedTimestring

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

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

    主机的 IP 地址。

    		192.168.XX.XX
    AutoRenewstring

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

    • true：开启
    • false（默认值）：不开启
    		false
    HostStatusstring

    主机状态，取值：

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

    主机的名称。

    		ch-8vbj9x74z874o****
    HostCPUinteger

    主机的 CPU，单位为核。

    		16
    OpenPermissionstring

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

    • 0：不可开放状态
    • 1：开放状态
    		1
    InstanceNumberinteger

    主机上部署实例的个数。

    		3
    CpuUsedstring

    主机 CPU 使用量。

    		36
    VPCIdstring

    专有网络的 ID。

    		vpc-wz9vu1jb32wn3sdd6****
    HostClassstring

    主机的规格。

    		mssql.host.c2xlarge
    RegionIdstring

    地域 ID。

    		cn-hangzhou
    InstanceNumberMasterinteger

    主机上的主节点数。

    		4
    VSwitchIdstring

    VSwitch ID。

    		vsw-bp1kaugqyrzb58oc1****
    InstanceNumberSlaveinteger

    主机上的备节点数。

    		1
    ExpiredTimestring

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

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

    可用区 ID。

    		cn-hangzhou-h
    CPUAllocationRatiostring

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

    		200
    ImageCategorystring

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

    • WindowsWithMssqlEntAlwaysonLicense：SQL Server 集群版

    • WindowsWithMssqlStdLicense：SQL Server 标准版

    • WindowsWithMssqlEntLicense：SQL Server 企业版

    • WindowsWithMssqlWebLicense：SQL Server Web 版

    		WindowsWithMssqlStdLicense
    DiskAllocationRatiostring

    专属集群的空间超配比。

    		200
    HostMeminteger

    主机的内存，单位为 MB。

    		2048
    AccountNamestring

    主机账号名称。

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

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

    • 包含 2~16 个字符。

    		cdp_system
    DistributionTagstring

    主机分布的标签。

    		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错误码错误信息描述
    400InvalidUserId.NotSupportThe userid have no permission.-
    403Forbidden.RAMUser not authorized to operate on the specified resource, or this API does not support RAM.操作被禁止
    403Permission.NotSupportThe user permission does not support the operation.权限不支持当前操作
    404InvalidDedicatedHostGroup.NotFoundSpecified DedicatedHostGroup does not exists.-

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