All Products
Search
Document Center

ApsaraDB for MyBase:QueryHostInstanceConsoleInfo

Last Updated:Jan 14, 2026

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cddc:QueryHostInstanceConsoleInfoget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the host. You can log on to the ApsaraDB for MyBase console to view the region ID.

cn-qingdao
DedicatedHostIdstringYes

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

D6E068C3-25BC-455A-85FE-45F0B22ECB1F
HostInstanceConsoleInfosarray<object>

The queried instances.

HostInstanceConsoleInfoobject
Statusstring

The state of the instance.

RUNNING
MaxConnIncreaseRatioValueinteger

The maximum number of connections to the instance.

1300
MemSizeinteger

The memory size of the instance. Unit: GB.

16
DiskSizeinteger

The storage capacity of the instance. Unit: GB.

500
Ipstring

The IP address of the host on which the instance is deployed.

172.22.XX.XX
Portstring

The port number of the host.

3443
EngineVersionstring

The version of the database engine.

5.8
MemoryIncreaseRatioValueinteger

The maximum memory size of the instance.

64
CpuIncreaseRatioValueinteger

The maximum number of CPU cores of the instance.

16
DBInstanceIdstring

The instance ID.

rm-bp1m5z8002gyj****
Enginestring

The database engine of the instance.

mysql
LevelNamestring

The instance type of the instance.

mysql.z2.medium.2
Rolestring

The role of the instance.

master
DBInstanceDescriptionstring

The description of the instance.

rm-bp1m5z8002gyj****
CpuCoresinteger

The number of CPU cores of the instance.

8
PerfInfoobject

The performance information of the host on which the instance is deployed.

PerfIdbPiofloat

The number of physical I/O operations performed on the host.

30
DiskCurrfloat

The disk storage of the host. Unit: GB.

1000
MemRatiofloat

The memory size of the host. Unit: GB.

64
CpuRatiofloat

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 codeError codeError messageDescription
403Permission.NotSupportYou are not authorized to perform this action.You are not authorized to perform the action.
403Forbidden.RAMUser 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.
404HostInfo.NotFoundThe host is not found.The host is not found.

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