调用QueryHostBaseInfoByInstance接口查询实例所在主机基本信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 否 QueryHostBaseInfoByInstance

系统规定参数，取值：QueryHostBaseInfoByInstance。

DBInstanceId String 是 rm-bp15rszyxs4t3****

实例ID。
RegionId String 否 cn-hangzhou

实例所在地域ID。可查看地域信息获取。

返回数据

名称 类型 示例值 描述
HostInstanceConsoleInfos Array of HostInstanceConsoleInfo

主机上实例信息概览。
ClusterName String rds.ebmr6.26xlarge

实例规格描述。
Engine String mysql

数据库类型。
EngineVersion String 5.7

数据库版本。
ExpiredTime String 2021.07.20

实例到期时间。
HostName String ch-bp1fgj3kt7fsb****

实例所在主机名称。
Ip String 172.22.0.***

实例所在主机IP地址。
Port String 3443

实例所在主机端口。
Role String master

实例角色。
Status String RUNNING

实例状态描述。
VpcId String vpc-bp1ov7as4yvz4kxei****

实例所在主机专有网络ID 。
RequestId String D6E068C3-25BC-455A-85FE-45F0B22E12CV

请求ID。

示例

请求示例

http(s)://cddc.aliyuncs.com/?Action=QueryHostBaseInfoByInstance
&DBInstanceId=rm-bp15rszyxs4t3****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

<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格式 

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

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBInstance.NotFound The specified instance does not exist or is not supported. 指定的实例不存在或不支持
403 Permission.NotSupport You are not authorized to perform this action. 不允许操作

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