QueryHostBaseInfoByInstance - 查看实例所在主机基本信息_云数据库专属集群(MyBase)-阿里云帮助中心

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cddc:QueryHostBaseInfoByInstance	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	实例所在地域 ID。可查看地域信息获取。	cn-hangzhou
DBInstanceId	string	是	实例 ID。	rm-bp15rszyxs4t3****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	D6E068C3-25BC-455A-85FE-45F0B22E12CV
HostInstanceConsoleInfos	array<object>	主机上实例信息概览。
HostInstanceConsoleInfo	object
VpcId	string	实例所在主机专有网络 ID 。	vpc-bp1ov7as4yvz4kxei****
Status	string	实例状态描述。	RUNNING
ExpiredTime	string	实例到期时间。	2021.07.20
ClusterName	string	实例规格描述。	rds.ebmr6.26xlarge
Ip	string	实例所在主机 IP 地址。	172.22.0.***
HostName	string	实例所在主机名称。	ch-bp1fgj3kt7fsb****
Engine	string	数据库类型。	mysql
Role	string	实例角色。	master
Port	string	实例所在主机端口。	3443
EngineVersion	string	数据库版本。	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	错误码	错误信息	描述
403	Permission.NotSupport	You are not authorized to perform this action.	不允许操作
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.	指定的实例不存在或不支持

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史