查询实例的Endpoint信息-阿里云帮助中心

背景信息

您已经创建了RDS MySQL集群版实例。
仅支持RDS MySQL集群版实例。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDBInstanceEndpoints	系统规定参数。取值：DescribeDBInstanceEndpoints。
ClientToken	String	否	ETnLKlblzczshOTUbOC****	该参数用于保证请求的幂等性，防止重复提交请求。参数值由客户端生成，保证在不同请求间唯一。该参数值由ASCII字符组成，最长不超过64个字符，不能包含非ASCII字符。
DBInstanceId	String	是	rm-u****	实例ID。可调用DescribeDBInstances查询。
DBInstanceEndpointId	String	否	ep-****-ro	实例的Endpoint ID。未传该参数表示返回所有Endpoint信息。

返回数据


名称	类型	示例值	描述
Data	Object		返回数据列表。
DBInstanceName	String	rm-u****	实例名称。
IpVersion	String	ipv4	IP地址协议版本。取值如下： ipv4 ipv6
DBInstanceEndpoints	Array of DBInstanceEndpoint		实例的Endpoint相关信息。
DBInstanceEndpoint
EndpointId	String	ep-****	实例的Endpoint ID。
EndpointType	String	Readonly	Endpoint类型，取值含义如下： Primary：实例的读写Endpoint Readonly：实例的只读Endpoint
EndpointDescription	String	for readonly business	用户自定义的Endpoint描述。
NodeItems	Array of NodeItem		Endpoint节点相关信息。
NodeItem
NodeId	String	rn-****13p6tum4289h	节点ID。
DBInstanceId	String	rm-u****	实例ID。
Weight	Integer	50	节点当前权重取值，按照该取值分配读流量。取值范围：0～100
AddressItems	Array of AddressItem		连接地址相关信息。
AddressItem
VpcId	String	vpc-bp17xdic25d****	VPC ID。
VSwitchId	String	vsw-bp12u14ecz****	交换机ID。
IpType	String	Private	IP类型，取值含义如下： Public：外网 Private：内网
Port	String	3306	连接端口号。
ConnectionString	String	rm****.mysql.rds.aliyuncs.com	连接地址。
IpAddress	String	10.71.XX.XX	IP地址。
RequestId	String	777C4593-8053-427B-****105593277CAB	请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceEndpoints
&ClientToken=ETnLKlblzczshOTUbOC****
&DBInstanceId=rm-u****
&DBInstanceEndpointId=ep-****-ro
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstanceEndpointsResponse>
    <Data>
        <DBInstanceName>rm-u****</DBInstanceName>
        <IpVersion>ipv4</IpVersion>
        <DBInstanceEndpoints>
            <EndpointId>ep-****</EndpointId>
            <EndpointType>Readonly</EndpointType>
            <EndpointDescription>for readonly business</EndpointDescription>
            <NodeItems>
                <NodeId>rn-****13p6tum4289h</NodeId>
                <DBInstanceId>rm-u****</DBInstanceId>
                <Weight>50</Weight>
            </NodeItems>
            <AddressItems>
                <VpcId>vpc-bp17xdic25d****</VpcId>
                <VSwitchId>vsw-bp12u14ecz****</VSwitchId>
                <IpType>Private</IpType>
                <Port>3306</Port>
                <ConnectionString>rm****.mysql.rds.aliyuncs.com</ConnectionString>
                <IpAddress>10.71.XX.XX</IpAddress>
            </AddressItems>
        </DBInstanceEndpoints>
    </Data>
    <RequestId>777C4593-8053-427B-****105593277CAB</RequestId>
</DescribeDBInstanceEndpointsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : {
    "DBInstanceName" : "rm-u****",
    "IpVersion" : "ipv4",
    "DBInstanceEndpoints" : [ {
      "EndpointId" : "ep-****",
      "EndpointType" : "Readonly",
      "EndpointDescription" : "for readonly business",
      "NodeItems" : [ {
        "NodeId" : "rn-****13p6tum4289h",
        "DBInstanceId" : "rm-u****",
        "Weight" : 50
      } ],
      "AddressItems" : [ {
        "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"
}

错误码


HttpCode	错误码	错误信息	描述
400	APICallingFailed	Meta db calling failed.	API调用异常。
400	InvalidSourceCategory	specified source category is invalid.	指定的源类别无效。
400	InvalidDBInstanceConnType.Format	Specified DB instance conn type is not valid.	操作失败，当前数据库实例的连接类型不支持此操作。
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.	子账号权限不足，请先获取授权。
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	操作失败，该实例状态下不支持此操作。
404	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	操作失败，实例处于锁定状态。
404	InvalidDBInstanceName.NotFound	The database instance does not exist.	数据库实例名称不存在。请确认数据名称是否正确。
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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