首页 云数据库 RDS API参考 API目录 集群版实例 CreateDBInstanceEndpoint - 创建实例的Endpoint

CreateDBInstanceEndpoint - 创建实例的Endpoint

该接口用于为RDS MySQL集群版实例创建Endpoint。

接口说明

适用引擎

RDS MySQL

相关功能文档

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

增加集群只读地址

调试

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

调试

授权信息

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

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

Endpoint节点相关信息列表。

DBInstanceIdstring否

实例ID。可调用DescribeDBInstances查询。

rm-****
NodeIdstring否

节点ID。

rn-xxxx-****
Weightlong否

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

取值范围：0～100

50

返回参数

名称类型描述示例值
object

返回参数详情。

Dataobject

返回数据列表。

DBInstanceNamestring

实例ID。

rm-****
DBInstanceEndpointIdstring

实例的Endpoint ID。

ep-****
ConnectionStringstring

内网连接地址。

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

请求ID。

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

示例

正常返回示例

JSON格式

{
  "Data": {
    "DBInstanceName": "rm-****",
    "DBInstanceEndpointId": "ep-****",
    "ConnectionString": "rm-****.mysql.rds.aliyuncs.com"
  },
  "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.数据库实例名称不存在，请检查。
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格式不正确或为空
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.指定的实例不存在指定的实例被删除或者实例不支持当前操作。

访问错误中心查看更多错误码。
阿里云首页 关系型数据库 相关技术圈