全部产品
Search
文档中心

云数据库 RDS:CreateDBInstanceEndpoint - 创建实例的Endpoint

更新时间:Nov 22, 2024

该接口用于为RDS集群系列实例创建Endpoint。

接口说明

适用引擎

RDS MySQL

相关功能文档

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

增加集群只读地址

调试

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

授权信息

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

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

请求参数

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

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

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

6000170000591aed949d0f****
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 查询。

rm-****
VpcIdstring

内网连接的 VPC ID。

vpc-xxxmmxjqqi****
VSwitchIdstring

内网连接的交换机 ID。

vsw-bp1kqp****
PrivateIpAddressstring

内网连接的 IP 地址。

172.16.XX.XX
ConnectionStringPrefixstring

内网连接地址前缀。

创建 Endpoint 的同时会自动创建一个内网连接地址,该参数表示内网连接地址的前缀。

rm-****-ro
Portstring

内网连接端口号。创建内网连接支持自定义端口号。

取值范围:3000~5999

3306
DBInstanceEndpointTypestring

Endpoint 类型,取值含义如下:

  • Primary:实例的读写 Endpoint

  • Readonly:实例的只读 Endpoint

Readonly
DBInstanceEndpointDescriptionstring

用户自定义的 Endpoint 描述。

for readonly business
NodeItemsarray<object>

Endpoint 节点相关信息列表。

object

Endpoint 节点详情。

DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 查询。

rm-****
NodeIdstring

节点 ID。

rn-xxxx-****
Weightlong

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

取值范围:0~100

50
ResourceGroupIdstring

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

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

Dataobject

返回数据列表。

ConnectionStringstring

内网连接地址。

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

实例的 Endpoint ID。

ep-****
DBInstanceNamestring

实例 ID。

rm-****
RequestIdstring

请求 ID。

C8E88DED-533F-4B3C-9207-731FBF394CCA

示例

正常返回示例

JSON格式

{
  "Data": {
    "ConnectionString": "rm-****.mysql.rds.aliyuncs.com",
    "DBInstanceEndpointId": "ep-****",
    "DBInstanceName": "rm-****"
  },
  "RequestId": "C8E88DED-533F-4B3C-9207-731FBF394CCA"
}

错误码

HTTP status code错误码错误信息描述
400InvalidSourceCategoryspecified source category is invalid.指定的源类别无效。
400InvalidDBInstanceConnType.FormatSpecified DB instance conn type is not valid.操作失败,当前数据库实例的连接类型不支持此操作。
400EndpointNum.ErrorThe number of endpoint is too many.Endpoint的数量过多,无法继续创建。
400InvalidNodeItems.DuplicateNodeIdDuplicate nodeId, please ensure all nodeIds are different.NodeItems参数中有重复的NodeId。
400InvalidNodeItems.RONodeReadOnly endpoint can not contain readonly instance node.只读endpoint不能包含只读实例的节点。
400InvalidNodeItems.RONodeIdPrimaryReadOnly endpoint can not contain primary node.只读endpoint不能包含primary节点。
400InvalidNodeItems.JsonFormatNodeItems is not a json string.NodeItems要求是一个JSON字符串。
400InvalidNodeItems.DBInstanceIdSpecified dbInstanceId is invalidNodeItems中dbInstanceId是无效的。
400InvalidNodeItems.NodeIdSpecified Node id is invalidNodeItems中存在NodeId不在集群节点中。
400EndpointType.NotSupportCurrent db type is not support specified endpoint type.不支持传入的Endpoint的类型。
400OtherEndpoint.ExistOther endpoint already exist.endpoint已存在。
400InvalidPort.MalformedSpecified port is not valid.指定的端口无效。
400APICallingFailedApi called failed, please check vpc vsw vip接口调用失败,请检查VPC、VSW、VIP等参数。
400InvalidDBInstanceName.NotFoundThe specified DB instance name does not exist.数据库实例名称不存在,请检查。
400InvalidNodeItems.BlackNodeItemsNodeItems is blank.节点数据不能为空。
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.您购买的模块不合法,请重新购买。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,该地域已裁撤。
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.您的信息不完整,请在操作前填写您的信息。
400Api.NotSupportSpecified api is not supported.当前接口不支持。
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
400KmsApiErrorUser secret key invalid.用户密钥失效。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.sql命令执行失败或执行超时
400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.当前实例引擎版本不支持归档冷数据。
400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.当前内核版本不支持归档冷数据。
400IncorrectTargetClasscodeThe current instance type does not support this operation.当前规格不支持此操作。
400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.链接地址名重复,请重新设置连接字符串。
400RequiredParam.NotFoundRequired input param is not found.没有传入必要的参数。
400Parameters.InvalidParameter error, please check the parameters.参数错误,请检查参数。
400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.数据归档不支持跨地域备份和秒级快照,请检查备份策略。
400InvalideStatus.FormatThe instance status does not support this operation.实例状态不支持此操作。
400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.实例释放后的归档备份保留策略无效。
400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.DB实例引擎类型不支持此操作。
400Pay.NoCreditCardNo credit cards.无信用卡。
400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.vpc网络类型实例不支持此操作。
400MirrorInsExistsSpecified DB instance mirror ins already existed.当前数据库实例镜像已存在。
400UnsupportedClassCodeThe specified DB instance class stops selling.实例规格停止售卖。
400InvalidBackupSetThe specified database does not exist in the backup set.备份集中没有指定的数据库。
400OrdTCommodityQueryErrorFailed to query for product.查询产品失败。
400ProductInstanceReleasedThe instance has been released. Please check before placing the order.实例已释放,请核实后下单。
400RegionEndTimeDissolvedIndiaThe region is no longer supported.指定的地域无效。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403InvalidConnVPCIdSpecified conn vpc id is not valid.指定的连接专有网络ID无效。
403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
403IncorrectMinorVersionCurrent engine minor version does not support operations.当前引擎小版本不支持此操作。
403OperationDenied.ZoneResourceThere is no available zone for inventory.没有可用的库存区域。
403NotInFlowControllerSorry,no permission.非集团上云用户不可用,无权限。
403InvalidKmsKeyKms key is disabled.Kms key已禁用。
403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.当前数据库实例级别不支持此操作。
404IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。
404InvalidConnectionString.NotFoundSpecified connection string or net type is not found.连接串不存在。请检查连接串是否正确。
404InvalidConnectionString.DuplicateSpecified connection string already exists in the Aliyun RDS.链接地址名重复,请重新设置连接字符串。
404InvalidWeight.FormatThe Specified Weight format is not valid.无效的权重范围。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
404Request.NotFoundThe requested resource is not available.请求的资源不可用。
404HostInfo.NotFoundThe specified host info is not found.指定的主机信息不存在。
500ExternalFailureThe request processing has failed due to external service failure.请求服务失败,请稍后重试。
500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.请求服务失败,请稍后再试或联系服务人员。
500InvokeProxyFailureThe request processing has failed due to service failure of rds api.由于rds api服务失败,请求处理失败。

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

变更历史

变更时间变更内容概要操作
2023-11-07OpenAPI 错误码发生变更查看变更详情
2023-09-08OpenAPI 错误码发生变更查看变更详情
2023-06-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情