Queries the basic information about the host on which a specified instance is created.

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 QueryHostBaseInfoByInstance

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

DBInstanceId String Yes rm-bp15rszyxs4t3****

The ID of the instance.

RegionId String No cn-hangzhou

The region ID of the instance. For more information, see Region IDs.

Response parameters

Parameter Type Example Description
HostInstanceConsoleInfos Array of HostInstanceConsoleInfo

An overview of the host on which a specified instance is created.

ClusterName String rds.ebmr6.26xlarge

The description of the instance type.

Engine String mysql

The type of the database engine.

EngineVersion String 5.7

The version of the database engine.

ExpiredTime String 2021.07.20

The expiration date of the host on which the instance is created.

HostName String ch-bp1fgj3kt7fsb****

The name of the host on which the instance is created.

Ip String 172.22.0.***

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

Port String 3443

The port of the host on which the instance is created.

Role String master

The role of the instance.

Status String RUNNING

The state of the instance.

VpcId String vpc-bp1ov7as4yvz4kxei****

The ID of the virtual private cloud (VPC) to which the dedicated cluster is connected. The host on which the instance is created is deployed in the dedicated cluster.

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

The ID of the request.

Examples

Sample requests

http(s)://cddc.aliyuncs.com/?Action=QueryHostBaseInfoByInstance
&DBInstanceId=rm-bp15rszyxs4t3****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<QueryHostBaseInfoByInstanceResponse>
<RequestId>D6E068C3-25BC-455A-85FE-45F0B22E12CV</RequestId>
<HostInstanceConsoleInfos>
    <Status>RUNNING</Status>
    <Role>master</Role>
    <EngineVersion>5.7</EngineVersion>
    <VpcId>vpc-bp1ov7as4yvz4kxei****</VpcId>
    <ExpiredTime>2021.07.20</ExpiredTime>
    <Port>3443</Port>
    <Ip> 172.22.0.***</Ip>
    <ClusterName>rds.ebmr6.26xlarge</ClusterName>
    <HostName>ch-bp1fgj3kt7fsb****</HostName>
    <Engine>mysql</Engine>
</HostInstanceConsoleInfos>
<QueryHostBaseInfoByInstanceResponse>

JSON format

{
    "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E12CV",
    "HostInstanceConsoleInfos": [
        {
            "Status": "RUNNING",
            "Role": "master",
            "EngineVersion": "5.7",
            "VpcId": "vpc-bp1ov7as4yvz4kxei****",
            "ExpiredTime": "2021.07.20",
            "Port": "3443",
            "Ip": " 172.22.0.***",
            "ClusterName": "rds.ebmr6.26xlarge",
            "HostName": "ch-bp1fgj3kt7fsb****",
            "Engine": "mysql"
        }
    ]
}

Error codes

HttpCode Error code Error message Description
404 InvalidDBInstance.NotFound The specified instance does not exist or is not supported. The error message returned because the instance does not exist or the operation cannot be performed on the instance.
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.