QueryHostInstanceConsoleInfo - 查询主机实例节点列表_云数据库专属集群(MyBase)-阿里云帮助中心

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	主机所在地域 ID。您可以登录云数据库专属集群控制台，查看地域信息。	cn-qingdao
DedicatedHostId	string	是	主机 ID。您可以登录云数据库专属集群控制台，在主机列表查看并获取主机 ID。	ch-bp1fgj3kt7fsb****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	D6E068C3-25BC-455A-85FE-45F0B22ECB1F
HostInstanceConsoleInfos	array<object>	实例信息列表。
	object
Status	string	实例状态描述。	RUNNING
MaxConnIncreaseRatioValue	integer	上弹连接数。	1300
MemSize	integer	实例规格内存，单位为 GB。	16
DiskSize	integer	实例存储空间，单位为 GB。	500
Ip	string	实例所在主机 IP。	172.22.XX.XX
Port	string	主机端口。	3443
EngineVersion	string	数据库版本。	5.8
MemoryIncreaseRatioValue	integer	上弹内存配置。	64
CpuIncreaseRatioValue	integer	上弹 CPU 配置。	16
DBInstanceId	string	实例 ID。	rm-bp1m5z8002gyj****
Engine	string	数据库类型。	mysql
LevelName	string	实例规格描述。	mysql.z2.medium.2
Role	string	实例角色。	master
DBInstanceDescription	string	实例描述。	rm-bp1m5z8002gyj****
CpuCores	integer	实例规格 CPU，单位为核。	8
PerfInfo	object	实例所在主机性能信息。
PerfIdbPio	float	实例所在主机物理 IO。	30
DiskCurr	float	实例所在主机磁盘空间，单位为 GB。	1000
MemRatio	float	实例所在主机内存大小，单位为 GB。	64
CpuRatio	float	实例所在主机 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	错误码	错误信息	描述
403	Permission.NotSupport	You are not authorized to perform this action.	不允许操作
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.	操作被禁止
404	HostInfo.NotFound	The host is not found.	主机不存在

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