调用CreateDBInstanceEndpointAddress接口创建实例外网连接地址。

背景信息

  • 仅支持MySQL集群版。
  • 创建Endpoint的外网连接地址，在一个Endpoint没有外网地址时，才可以创建该Endpoint外网地址。
  • 流量分配权重等配置与该Endpoint的内网地址的配置一致。每一个Endpoint只能有一个外网地址和内网地址。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateDBInstanceEndpointAddress

系统规定参数。

取值：CreateDBInstanceEndpointAddress。

ClientToken String 否 6000170000591aed949d0f****

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

该参数值由ASCII字符组成，最长不超过64个字符，不能包含非ASCII字符。
DBInstanceId String 是 rm-****

实例ID。可调用DescribeDBInstances查询。

DBInstanceEndpointId String 是 ep-****

实例的Endpoint ID。可调用DescribeDBInstanceEndpoints查询。

ConnectionStringPrefix String 是 rm-*****

外网连接地址的前缀。
Port String 是 3306

外网连接地址端口号。
IpType String 是 Public

连接地址的网络类型，仅支持外网类型，取值为Public。

返回数据

名称 类型 示例值 描述
Data Object

返回字段列表。
DBInstanceName String rm-****

实例ID。
DBInstanceEndpointId String ep-****

实例的Endpoint ID。
ConnectionString String rm-******.mysql.rds.aliyuncs.com

外网连接地址。
RequestId String 08A3B71B-FE08-4B03-974F-CC7EA6DB1828

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=CreateDBInstanceEndpointAddress
&ClientToken=6000170000591aed949d0f****
&DBInstanceId=rm-****
&DBInstanceEndpointId=ep-****
&ConnectionStringPrefix=new****
&Port=3306
&IpType=Public
&公共请求参数

正常返回示例

XML格式 

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

<CreateDBInstanceEndpointAddressResponse>
    <Data>
        <DBInstanceName>rm-****</DBInstanceName>
        <DBInstanceEndpointId>ep-****</DBInstanceEndpointId>
        <ConnectionString>rm-******.mysql.rds.aliyuncs.com</ConnectionString>
    </Data>
    <RequestId>08A3B71B-FE08-4B03-974F-CC7EA6DB1828</RequestId>
</CreateDBInstanceEndpointAddressResponse>

JSON格式 

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

{
  "Data" : {
    "DBInstanceName" : "rm-****",
    "DBInstanceEndpointId" : "ep-****",
    "ConnectionString" : "rm-******.mysql.rds.aliyuncs.com"
  },
  "RequestId" : "08A3B71B-FE08-4B03-974F-CC7EA6DB1828"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidSourceCategory specified source category is invalid. 指定的源类别无效。
400 InvalidDBInstanceConnType.Format Specified DB instance conn type is not valid. 操作失败，当前数据库实例的连接类型不支持此操作。
400 IncorrectDBInstanceNetType Current DB instance net type does not support this operation. 操作失败，实例网络类型不支持。
400 EndpointType.NotSupport Current db type is not support specified endpoint type. 不支持传入的Endpoint的类型。
400 APICallingFailed Meta db calling failed. API调用异常。
403 IncorrectDBInstanceState Current DB instance state does not support this operation. 操作失败，该实例状态下不支持此操作。
403 NetTypeExists Specified net type already existed. 网络类型切换失败，当前网络类型已经存在。
404 InvalidDBInstanceName.NotFound Invalid DBInstanceId NotFound. 数据库实例ID不存在，请检查。
404 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. 操作失败，实例处于锁定状态。
404 InvalidConnectionString.Duplicate Specified connection string already exists in the Aliyun RDS. 链接地址名重复，请重新设置连接字符串。
404 Endpoint.NotFound Specified endpoint is not existed. 目标的endpoint不存在。
404 InvalidDBInstance.NotFound Specified instance does not exist or not support. 指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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