QueryHostInstanceConsoleInfo - 云数据库专属集群 MyBase

调试

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

请求参数


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

返回数据


名称	类型	示例值	描述
RequestId	String	D6E068C3-25BC-455A-85FE-45F0B22ECB1F	请求ID。
HostInstanceConsoleInfos	Array of HostInstanceConsoleInfo		实例信息列表。
Status	String	RUNNING	实例状态描述。
MaxConnIncreaseRatioValue	Integer	1300	上弹连接数。
MemSize	Integer	16	实例规格内存，单位为GB。
DiskSize	Integer	500	实例存储空间，单位为GB。
Ip	String	172.22.XX.XX	实例所在主机IP。
Port	String	3443	主机端口。
EngineVersion	String	5.8	数据库版本。
MemoryIncreaseRatioValue	Integer	64	上弹内存配置。
CpuIncreaseRatioValue	Integer	16	上弹CPU配置。
DBInstanceId	String	rm-bp1m5z8002gyj****	实例ID。
Engine	String	mysql	数据库类型。
LevelName	String	mysql.z2.medium.2	实例规格描述。
Role	String	master	实例角色。
DBInstanceDescription	String	rm-bp1m5z8002gyj****	实例描述。
CpuCores	Integer	8	实例规格CPU，单位为核。
PerfInfo	Object		实例所在主机性能信息。
PerfIdbPio	Float	30	实例所在主机物理IO。
DiskCurr	Float	1000	实例所在主机磁盘空间，单位为GB。
MemRatio	Float	64	实例所在主机内存大小，单位为GB。
CpuRatio	Float	16	实例所在主机CPU大小，单位为核。

示例

请求示例

http(s)://cddc.aliyuncs.com/?Action=QueryHostInstanceConsoleInfo
&DedicatedHostId=ch-bp1fgj3kt7fsb****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
    }
  } ]
}

错误码


HttpCode	错误码	错误信息	描述
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.	主机不存在

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