文档

QueryHostBaseInfoByInstance - 查看实例所在主机基本信息

更新时间:

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
DBInstanceIdstring

实例 ID。

rm-bp15rszyxs4t3****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D6E068C3-25BC-455A-85FE-45F0B22E12CV
HostInstanceConsoleInfosobject []

主机上实例信息概览。

VpcIdstring

实例所在主机专有网络 ID 。

vpc-bp1ov7as4yvz4kxei****
Statusstring

实例状态描述。

RUNNING
ExpiredTimestring

实例到期时间。

2021.07.20
ClusterNamestring

实例规格描述。

rds.ebmr6.26xlarge
Ipstring

实例所在主机 IP 地址。

172.22.0.***
HostNamestring

实例所在主机名称。

ch-bp1fgj3kt7fsb****
Enginestring

数据库类型。

mysql
Rolestring

实例角色。

master
Portstring

实例所在主机端口。

3443
EngineVersionstring

数据库版本。

5.7

示例

正常返回示例

JSON格式

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

JSON格式

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

错误码

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

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

  • 本页导读 (1)
文档反馈