首页 云数据库 RDS API参考 API目录 安全加密 DescribeDBInstanceIpHostname - 查询实例底层ECS实例的Hostname

DescribeDBInstanceIpHostname - 查询实例底层ECS实例的Hostname

调用DescribeDBInstanceIpHostname接口查询RDS实例的底层ECS实例的Hostname。

接口说明

该接口仅支持RDS SQL Server实例。

RDS实例是基于ECS实例搭建的,本接口用于设置分布式事务白名单时查询RDS实例的底层ECS实例的Hostname,以及查询RDS实例的主机WebShell登录信息时使用。

RDS实例需满足如下条件:

  • 实例系列:基础版、高可用版(2012及以上版本)、集群版
  • 实例规格:通用型、独享型(不支持共享型)
  • 实例创建时间:基础版实例的创建时间需在2022年09月02日或之后。实例创建时间可在基本信息页内的运行状态中查看。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeDBInstanceIpHostnameREAD
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

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

RDS实例ID。

rm-uf6wjk5********
RegionIdstring

RDS实例地域ID,可以调用DescribeDBInstanceAttribute接口查看。

cn-hangzhou

返回参数

名称类型描述示例值
object
DBInstanceIdstring

实例ID。

rm-uf6wjk5*******
RequestIdstring

请求ID。

67CD4719-51E3-4A76-A38C-02F45FAE7E36
IpHostnameInfosstring

RDS实例所在ECS实例的内网IP和ECS主机名,包含主备实例。格式为:ip1,hostname1;ip2,hostname2

172.16.xx.xx,sdxxxxxxxxB;172.16.xx.xx,sdxxxxxxxxA

示例

正常返回示例

JSON格式

{
  "DBInstanceId": "rm-uf6wjk5*******",
  "RequestId": "67CD4719-51E3-4A76-A38C-02F45FAE7E36",
  "IpHostnameInfos": "172.16.xx.xx,sdxxxxxxxxB;172.16.xx.xx,sdxxxxxxxxA"
}

错误码

HTTP status code错误码错误信息描述
400EngineNotSupportedEngine specified cannot be supported the operation.操作失败,当前引擎不支持此操作,请升级内核小版本。
400InvalidEngineVersion.MalformedSpecified engine version is not valid.数据库引擎版本无效,请确认后重试。
403IncorrectDBInstanceTypeCurrent DB instance engine and type does not support operations.操作失败,当前数据库实例引擎和类型不支持。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.实例状态非运行中
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.数据库实例ID不存在,请检查。

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

变更历史

变更时间变更内容概要操作
2022-06-23OpenAPI 描述信息更新
变更项变更内容
API 描述OpenAPI 描述信息更新
阿里云首页 关系型数据库 相关技术圈