备案控制台
文档
产品文档
输入文档关键字查找
首页 云数据库 RDS 开发参考 API参考 API目录 RDS MySQL集群系列实例 CreateDBInstanceEndpointAddress - 创建Endpoint外网连接地址

CreateDBInstanceEndpointAddress - 创建Endpoint外网连接地址

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

该接口用于为RDS MySQL集群系列实例创建Endpoint的外网连接地址。

接口说明

适用引擎

RDS MySQL

注意事项

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

调试

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

授权信息

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

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

请求参数

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

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

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

6000170000591aed949d0f****
DBInstanceIdstring是

实例 ID。可调用 DescribeDBInstances 查询。

rm-****
DBInstanceEndpointIdstring是

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

ep-****
ConnectionStringPrefixstring是

外网连接地址的前缀。

rm-****
Portstring是

外网连接地址端口号。

3306
IpTypestring是

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

Public
ResourceGroupIdstring否

资源组 ID。可调用 DescribeDBInstanceAttribute 获取。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

Dataobject

返回字段列表。

DBInstanceNamestring

实例 ID。

rm-****
DBInstanceEndpointIdstring

实例的 Endpoint ID。

ep-****
ConnectionStringstring

外网连接地址。

rm-****.mysql.rds.aliyuncs.com
RequestIdstring

请求 ID。

08A3B71B-FE08-4B03-974F-CC7EA6DB1828

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidSourceCategoryspecified source category is invalid.指定的源类别无效。
400InvalidDBInstanceConnType.FormatSpecified DB instance conn type is not valid.操作失败，当前数据库实例的连接类型不支持此操作。
400IncorrectDBInstanceNetTypeCurrent DB instance net type does not support this operation.操作失败，实例网络类型不支持。
400EndpointType.NotSupportCurrent db type is not support specified endpoint type.不支持传入的Endpoint的类型。
400APICallingFailedMeta db calling failed.API调用异常。
400EngineNotSupportedThe engine does not support the operation.当前引擎不支持此操作。
400InvalidEngineVersion.NotSupportThe specified parameter "EngineVersion" is not valid.无效的引擎版本参数。请重新设置：MySQL：5.5/5.6/5.7；SQLServer：2008r2/2012；PostgreSQL：9.4；PPAS：9.3。
400InvalidBizType.FormatSpecified biz type 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.您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0，请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法，请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好，印度地域裁撤，购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题，请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单，请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善，请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常，详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整，请在操作前填写您的信息。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403NetTypeExistsSpecified net type already existed.网络类型切换失败，当前网络类型已经存在。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单，请支付后重试。
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.数据库实例ID不存在，请检查。
404IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败，实例处于锁定状态。
404InvalidConnectionString.DuplicateSpecified connection string already exists in the Aliyun RDS.链接地址名重复，请重新设置连接字符串。
404Endpoint.NotFoundSpecified endpoint is not existed.目标的endpoint不存在。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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

变更历史

变更时间变更内容概要操作
2023-06-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
    删除错误码：403
    删除错误码：404
入参OpenAPI 入参发生变更。
    新增入参：ResourceGroupId
2023-06-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    删除错误码：403
    删除错误码：404
2023-05-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    删除错误码：403
    删除错误码：404
  • 本页导读 （1）
文档反馈