文档

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

更新时间:

该接口用于查询RDS SQL Server实例底层ECS实例的Hostname。

接口说明

适用引擎

RDS SQL Server

前提条件

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

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

设置分布式事务白名单

调试

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

授权信息

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

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

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
RegionIdstring

地域 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,sd****B;172.16.xx.xx,sd****A

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400EngineNotSupportedEngine specified cannot be supported the operation.操作失败,当前引擎不支持此操作,请升级内核小版本。
400InvalidEngineVersion.MalformedSpecified engine version is not valid.数据库引擎版本无效,请确认后重试。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
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 描述信息更新
  • 本页导读 (1)
文档反馈