Queries instances on a host.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No QueryHostInstanceConsoleInfo

The operation that you want to perform. Set the value to QueryHostInstanceConsoleInfo.

DedicatedHostId String Yes ch-bp1fgj3kt7fsb****

The ID of the host. You can call the DescribeDedicatedHosts operation to query the host ID.

RegionId String No cn-qingdao

The region ID of the host. You can view the region where your host is deployed on the Host Information tab of the host details page in the ApsaraDB for MyBase console. Then, you can query the region ID from the region list. For more information, see Region IDs.

Response parameters

Parameter Type Example Description
HostInstanceConsoleInfos Array of HostInstanceConsoleInfo

Details about the returned instances.

CpuCores Integer 8

The number of CPU cores that is defined by the instance type. Unit: core.

CpuIncreaseRatioValue Integer 16

The number of CPU cores to which the instance can be increased.

DBInstanceDescription String rm-bp1m5z8002gyj****

The description of the instance.

DBInstanceId String rm-bp1m5z8002gyj****

The ID of the instance.

DiskSize Integer 500

The storage capacity of the instance. Unit: GB.

Engine String mysql

The type of the database engine.

EngineVersion String 5.8

The version of the database engine.

Ip String 172.22.0.***

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

LevelName String mysql.z2.medium.2

The description of the instance type.

MaxConnIncreaseRatioValue Integer 1300

The number of connections to which the instance can be increased.

MemSize Integer 16

The memory that is defined by the instance type. Unit: GB.

MemoryIncreaseRatioValue Integer 64

The memory to which the instance can be increased.

PerfInfo Struct

The information about the performance of the host on which the instance is created.

CpuRatio Float 16

The number of CPU cores that are configured for the host on which the instance is created. Unit: core.

DiskCurr Float 1000

The disk space of the host on which the instance is created. Unit: GB.

MemRatio Float 64

The memory of the host on which the instance is created. Unit: GB.

PerfIdbPio Float 30

The number of physical I/O operations performed on the host on which the instance is created.

Port String 3443

The port of the host.

Role String master

The role of the instance.

Status String RUNNING

The state of the instance.

RequestId String D6E068C3-25BC-455A-85FE-45F0B22ECB1F

The ID of the request.

Examples

Sample requests

http(s)://cddc.aliyuncs.com/?Action=QueryHostInstanceConsoleInfo
&DedicatedHostId=ch-bp1fgj3kt7fsb****
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

HttpCode Error code Error message Description
403 Permission.NotSupport You are not authorized to perform this action. The error message returned because you are not authorized to perform this operation.

For a list of error codes, visit the API Error Center.