QueryHostInstanceConsoleInfo - ApsaraDB for MyBase - Alibaba Cloud Documentation Center

Queries the information about instances that are deployed on a host.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the host. You can log on to the ApsaraDB for MyBase console to view the region ID.	cn-qingdao
DedicatedHostId	string	Yes	The host ID. You can log on to the ApsaraDB for MyBase console and go to the Hosts page to view the host ID.	ch-bp1fgj3kt7fsb****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22ECB1F
HostInstanceConsoleInfos	object []	The queried instances.
Status	string	The state of the instance.	RUNNING
MaxConnIncreaseRatioValue	integer	The maximum number of connections to the instance.	1300
MemSize	integer	The memory size of the instance. Unit: GB.	16
DiskSize	integer	The storage capacity of the instance. Unit: GB.	500
Ip	string	The IP address of the host on which the instance is deployed.	172.22.XX.XX
Port	string	The port number of the host.	3443
EngineVersion	string	The version of the database engine.	5.8
MemoryIncreaseRatioValue	integer	The maximum memory size of the instance.	64
CpuIncreaseRatioValue	integer	The maximum number of CPU cores of the instance.	16
DBInstanceId	string	The instance ID.	rm-bp1m5z8002gyj****
Engine	string	The database engine of the instance.	mysql
LevelName	string	The instance type of the instance.	mysql.z2.medium.2
Role	string	The role of the instance.	master
DBInstanceDescription	string	The description of the instance.	rm-bp1m5z8002gyj****
CpuCores	integer	The number of CPU cores of the instance.	8
PerfInfo	object	The performance information of the host on which the instance is deployed.
PerfIdbPio	float	The number of physical I/O operations performed on the host.	30
DiskCurr	float	The disk storage of the host. Unit: GB.	1000
MemRatio	float	The memory size of the host. Unit: GB.	64
CpuRatio	float	The number of CPU cores of the host.	16

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
403	Permission.NotSupport	You are not authorized to perform this action.	You are not authorized to perform the action.
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.	The user is not authorized to operate on the specified resource.
404	HostInfo.NotFound	The host is not found.	The host is not found.

For a list of error codes, visit the Service error codes.