首页 云数据库 RDS API参考 API目录 集群版实例 DescribeDBInstanceEndpoints - 查询实例 Endpoint 信息

DescribeDBInstanceEndpoints - 查询实例 Endpoint 信息

查询实例 Endpoint 信息。

接口说明

背景信息

  • 您已经创建了RDS MySQL集群版实例。

  • 仅支持RDS MySQL集群版实例。

调试

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

调试

授权信息

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

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

请求参数

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

该参数用于保证请求的幂等性,防止重复提交请求。参数值由客户端生成,保证在不同请求间唯一。

该参数值由ASCII字符组成,最长不超过64个字符,不能包含非ASCII字符。

ETnLKlblzczshOTUbOC****
DBInstanceIdstring

实例ID。可调用DescribeDBInstances查询。

rm-u****
DBInstanceEndpointIdstring

实例的Endpoint ID。

未传该参数表示返回所有Endpoint信息。

ep-****-ro

返回参数

名称类型描述示例值
object

返回信息。

Dataobject

返回数据列表。

DBInstanceNamestring

实例名称。

rm-u****
IpVersionstring

IP地址协议版本。取值如下:

  • ipv4
  • ipv6
ipv4
DBInstanceEndpointsarray

实例的Endpoint相关信息。

object

Endpoint详情。

EndpointIdstring

实例的Endpoint ID。

ep-****
EndpointTypestring

Endpoint类型,取值含义如下:

  • Primary:实例的读写Endpoint
  • Readonly:实例的只读Endpoint
Readonly
EndpointDescriptionstring

用户自定义的Endpoint描述。

for readonly business
NodeItemsarray

Endpoint节点相关信息。

object

Endpoint详情。

NodeIdstring

节点ID。

rn-****13p6tum4289h
DBInstanceIdstring

实例ID。

rm-u****
Weightinteger

节点当前权重取值,按照该取值分配读流量。

取值范围:0~100

50
AddressItemsarray

连接地址相关信息。

object

连接详情。

VpcIdstring

VPC ID。

vpc-bp17xdic25d****
VSwitchIdstring

交换机ID。

vsw-bp12u14ecz****
IpTypestring

IP类型,取值含义如下:

  • Public:外网
  • Private:内网
Private
Portstring

连接端口号。

3306
ConnectionStringstring

连接地址。

rm****.mysql.rds.aliyuncs.com
IpAddressstring

IP地址。

10.71.XX.XX
RequestIdstring

请求ID。

777C4593-8053-427B-****105593277CAB

示例

正常返回示例

JSON格式

{
  "Data": {
    "DBInstanceName": "rm-u****",
    "IpVersion": "ipv4",
    "DBInstanceEndpoints": {
      "DBInstanceEndpoint": [
        {
          "EndpointId": "ep-****",
          "EndpointType": "Readonly",
          "EndpointDescription": "for readonly business",
          "NodeItems": {
            "NodeItem": [
              {
                "NodeId": "rn-****13p6tum4289h",
                "DBInstanceId": "rm-u****",
                "Weight": 50
              }
            ]
          },
          "AddressItems": {
            "AddressItem": [
              {
                "VpcId": "vpc-bp17xdic25d****",
                "VSwitchId": "vsw-bp12u14ecz****",
                "IpType": "Private",
                "Port": "3306",
                "ConnectionString": "rm****.mysql.rds.aliyuncs.com",
                "IpAddress": "10.71.XX.XX"
              }
            ]
          }
        }
      ]
    }
  },
  "RequestId": "777C4593-8053-427B-****105593277CAB"
}

错误码

HTTP status code错误码错误信息描述
400APICallingFailedMeta db calling failed.API调用异常。
400InvalidSourceCategoryspecified source category is invalid.指定的源类别无效。
400InvalidDBInstanceConnType.FormatSpecified DB instance conn type is not valid.操作失败,当前数据库实例的连接类型不支持此操作。
400ForbiddenUser not authorized to operate on the specified resource, or this API does not support RAM.子账号权限不足,请先获取授权。
400InvalidEngineVersion.NotSupportThe specified parameter "EngineVersion" is not valid.无效的引擎版本参数。请重新设置:MySQL:5.5/5.6/5.7;SQLServer:2008r2/2012;PostgreSQL:9.4;PPAS:9.3。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.实例状态非运行中
404IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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

变更历史

变更时间变更内容概要操作
2023-05-09OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
阿里云首页 关系型数据库 相关技术圈