Creates an endpoint for an ApsaraDB RDS for MySQL instance that runs RDS Cluster Edition.
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
rds:CreateDBInstanceEndpoint | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. | 6000170000591aed949d0f**** |
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance. | rm-**** |
VpcId | string | Yes | The virtual private cloud (VPC) ID of the internal endpoint. | vpc-xxxmmxjqqi**** |
VSwitchId | string | Yes | The vSwitch ID of the internal endpoint. | vsw-bp1kqp**** |
PrivateIpAddress | string | No | The IP address of the internal endpoint. | 172.16.XX.XX |
ConnectionStringPrefix | string | Yes | The prefix of the internal endpoint. When you create any type of endpoint, an internal endpoint is automatically created for the endpoint. This parameter specifies the prefix of the internal endpoint. | rm-****-ro |
Port | string | Yes | The port number of the internal endpoint. You can specify the port number for the internal endpoint. Valid values: 3000 to 5999. | 3306 |
DBInstanceEndpointType | string | Yes | The type of the endpoint. Valid values:
| Readonly |
DBInstanceEndpointDescription | string | No | The user-defined description of the endpoint. | for readonly business |
NodeItems | object [] | Yes | The information about the node that is configured for the endpoint. | |
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance. | rm-**** |
NodeId | string | Yes | The node ID. | rn-xxxx-**** |
Weight | long | No | The weight of the node. Read requests are distributed based on the weight. Valid values: 0 to 100. | 50 |
ResourceGroupId | string | No | The ID of the resource group. You can call the DescribeDBInstanceAttribute to obtain the ID of the resource group. | rg-acfmy**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"Data": {
"DBInstanceName": "rm-****",
"DBInstanceEndpointId": "ep-****",
"ConnectionString": "rm-****.mysql.rds.aliyuncs.com"
},
"RequestId": "C8E88DED-533F-4B3C-9207-731FBF394CCA"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidSourceCategory | specified source category is invalid. | The specified source category is invalid. |
400 | InvalidDBInstanceConnType.Format | Specified DB instance conn type is not valid. | The operation failed. The operation is not supported for the connection type of the RDS instance. |
400 | EndpointNum.Error | The number of endpoint is too many. | - |
400 | InvalidNodeItems.DuplicateNodeId | Duplicate nodeId, please ensure all nodeIds are different. | Duplicate NodeId parameter values exist in NodeItems. |
400 | InvalidNodeItems.RONode | ReadOnly endpoint can not contain readonly instance node. | The read-only endpoint cannot contain the read-only instance. |
400 | InvalidNodeItems.RONodeIdPrimary | ReadOnly endpoint can not contain primary node. | The read-only endpoint cannot contain the primary instance. |
400 | InvalidNodeItems.JsonFormat | NodeItems is not a json string. | The NodeItems parameter value must be a JSON string. |
400 | InvalidNodeItems.DBInstanceId | Specified dbInstanceId is invalid | The specified dbInstanceId parameter in NodeItems is invalid. |
400 | InvalidNodeItems.NodeId | Specified Node id is invalid | A NodeId parameter value in NodeItems is not found among instances. |
400 | EndpointType.NotSupport | Current db type is not support specified endpoint type. | The specified endpoint type is invalid. |
400 | OtherEndpoint.Exist | Other endpoint already exist. | - |
400 | InvalidPort.Malformed | Specified port is not valid. | The port number is invalid. |
400 | APICallingFailed | Api called failed, please check vpc vsw vip | - |
400 | InvalidDBInstanceName.NotFound | The specified DB instance name does not exist. | The instance name does not exist. |
400 | InvalidNodeItems.BlackNodeItems | NodeItems is blank. | - |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
403 | InvalidConnVPCId | Specified conn vpc id is not valid. | The specified VPC ID is invalid. |
403 | InvalidVswitchId | Specified conn vswitch id is not valid. | - |
404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | The operation failed. The RDS instance is locked. |
404 | InvalidConnectionString.NotFound | Specified connection string or net type is not found. | The endpoint cannot be found. Check the endpoint. |
404 | InvalidConnectionString.Duplicate | Specified connection string already exists in the Aliyun RDS. | The endpoint is duplicate. Specify a different endpoint. |
404 | InvalidWeight.Format | The Specified Weight format is not valid. | The weight range is invalid. |
404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | The RDS instance cannot be found, is deleted, or does not support the operation. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-11-07 | The Error code has changed | see changesets | ||||||||||||
| ||||||||||||||
2023-09-08 | The Error code has changed | see changesets | ||||||||||||
| ||||||||||||||
2023-06-27 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||
|