文档

QueryHostInstanceConsoleInfo - 查询主机实例节点列表

更新时间:

调用QueryHostInstanceConsoleInfo接口查询主机实例节点列表。

调试

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

调试

授权信息

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

请求参数

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

主机所在地域ID。您可以登录云数据库专属集群控制台,查看地域信息

cn-qingdao
DedicatedHostIdstring

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

ch-bp1fgj3kt7fsb****

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

D6E068C3-25BC-455A-85FE-45F0B22ECB1F
HostInstanceConsoleInfosobject []

实例信息列表。

Statusstring

实例状态描述。

RUNNING
MaxConnIncreaseRatioValueinteger

上弹连接数。

1300
MemSizeinteger

实例规格内存,单位为GB。

16
DiskSizeinteger

实例存储空间,单位为GB。

500
Ipstring

实例所在主机IP。

172.22.XX.XX
Portstring

主机端口。

3443
EngineVersionstring

数据库版本。

5.8
MemoryIncreaseRatioValueinteger

上弹内存配置。

64
CpuIncreaseRatioValueinteger

上弹CPU配置。

16
DBInstanceIdstring

实例ID。

rm-bp1m5z8002gyj****
Enginestring

数据库类型。

mysql
LevelNamestring

实例规格描述。

mysql.z2.medium.2
Rolestring

实例角色。

master
DBInstanceDescriptionstring

实例描述。

rm-bp1m5z8002gyj****
CpuCoresinteger

实例规格CPU,单位为核。

8
PerfInfoobject

实例所在主机性能信息。

PerfIdbPiofloat

实例所在主机物理IO。

30
DiskCurrfloat

实例所在主机磁盘空间,单位为GB。

1000
MemRatiofloat

实例所在主机内存大小,单位为GB。

64
CpuRatiofloat

实例所在主机CPU大小,单位为核。

16

示例

正常返回示例

JSON格式

{
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "HostInstanceConsoleInfos": [
    {
      "Status": "RUNNING",
      "MaxConnIncreaseRatioValue": 1300,
      "MemSize": 16,
      "DiskSize": 500,
      "Ip": "172.22.XX.XX",
      "Port": "3443",
      "EngineVersion": "5.8",
      "MemoryIncreaseRatioValue": 64,
      "CpuIncreaseRatioValue": 16,
      "DBInstanceId": "rm-bp1m5z8002gyj****",
      "Engine": "mysql",
      "LevelName": "mysql.z2.medium.2",
      "Role": "master",
      "DBInstanceDescription": "rm-bp1m5z8002gyj****",
      "CpuCores": 8,
      "PerfInfo": {
        "PerfIdbPio": 30,
        "DiskCurr": 1000,
        "MemRatio": 64,
        "CpuRatio": 16
      }
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403Permission.NotSupportYou are not authorized to perform this action.不允许操作
403Forbidden.RAMUser not authorized to operate on the specified resource, or this API does not support RAM.操作被禁止
404HostInfo.NotFoundThe host is not found.主机不存在

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

  • 本页导读 (1)
文档反馈