All Products
Search

This Product

    ApsaraDB RDS:CreateDBInstanceEndpoint

    Document Center

    ApsaraDB RDS:CreateDBInstanceEndpoint

    最終更新日:Apr 28, 2024

    Creates an endpoint for an ApsaraDB RDS for MySQL instance that runs RDS Cluster Edition.

    Operation description

    Supported database engine

    MySQL

    References

    Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation:

    Add a read-only endpoint for a cluster

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:CreateDBInstanceEndpointWrite
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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****
    DBInstanceIdstringYes

    The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance.

    		rm-****
    VpcIdstringYes

    The virtual private cloud (VPC) ID of the internal endpoint.

    		vpc-xxxmmxjqqi****
    VSwitchIdstringYes

    The vSwitch ID of the internal endpoint.

    		vsw-bp1kqp****
    PrivateIpAddressstringNo

    The IP address of the internal endpoint.

    		172.16.XX.XX
    ConnectionStringPrefixstringYes

    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
    PortstringYes

    The port number of the internal endpoint. You can specify the port number for the internal endpoint.

    Valid values: 3000 to 5999.

    		3306
    DBInstanceEndpointTypestringYes

    The type of the endpoint. Valid values:

    • Primary: read/write endpoint of the instance
    • Readonly: read-only endpoint of the instance
    		Readonly
    DBInstanceEndpointDescriptionstringNo

    The user-defined description of the endpoint.

    		for readonly business
    NodeItemsobject []Yes

    The information about the node that is configured for the endpoint.

    DBInstanceIdstringYes

    The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance.

    		rm-****
    NodeIdstringYes

    The node ID.

    		rn-xxxx-****
    WeightlongNo

    The weight of the node. Read requests are distributed based on the weight.

    Valid values: 0 to 100.

    		50
    ResourceGroupIdstringNo

    The ID of the resource group. You can call the DescribeDBInstanceAttribute to obtain the ID of the resource group.

    		rg-acfmy****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    Dataobject

    The data returned.

    DBInstanceNamestring

    The ID of the instance.

    		rm-****
    DBInstanceEndpointIdstring

    The endpoint ID of the instance.

    		ep-****
    ConnectionStringstring

    The internal endpoint.

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

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidSourceCategoryspecified source category is invalid.The specified source category is invalid.
    400InvalidDBInstanceConnType.FormatSpecified DB instance conn type is not valid.The operation failed. The operation is not supported for the connection type of the RDS instance.
    400EndpointNum.ErrorThe number of endpoint is too many.-
    400InvalidNodeItems.DuplicateNodeIdDuplicate nodeId, please ensure all nodeIds are different.Duplicate NodeId parameter values exist in NodeItems.
    400InvalidNodeItems.RONodeReadOnly endpoint can not contain readonly instance node.The read-only endpoint cannot contain the read-only instance.
    400InvalidNodeItems.RONodeIdPrimaryReadOnly endpoint can not contain primary node.The read-only endpoint cannot contain the primary instance.
    400InvalidNodeItems.JsonFormatNodeItems is not a json string.The NodeItems parameter value must be a JSON string.
    400InvalidNodeItems.DBInstanceIdSpecified dbInstanceId is invalidThe specified dbInstanceId parameter in NodeItems is invalid.
    400InvalidNodeItems.NodeIdSpecified Node id is invalidA NodeId parameter value in NodeItems is not found among instances.
    400EndpointType.NotSupportCurrent db type is not support specified endpoint type.The specified endpoint type is invalid.
    400OtherEndpoint.ExistOther endpoint already exist.-
    400InvalidPort.MalformedSpecified port is not valid.The port number is invalid.
    400APICallingFailedApi called failed, please check vpc vsw vip-
    400InvalidDBInstanceName.NotFoundThe specified DB instance name does not exist.The instance name does not exist.
    400InvalidNodeItems.BlackNodeItemsNodeItems is blank.-
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    403InvalidConnVPCIdSpecified conn vpc id is not valid.The specified VPC ID is invalid.
    403InvalidVswitchIdSpecified conn vswitch id is not valid.-
    404IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.The operation failed. The RDS instance is locked.
    404InvalidConnectionString.NotFoundSpecified connection string or net type is not found.The endpoint cannot be found. Check the endpoint.
    404InvalidConnectionString.DuplicateSpecified connection string already exists in the Aliyun RDS.The endpoint is duplicate. Specify a different endpoint.
    404InvalidWeight.FormatThe Specified Weight format is not valid.The weight range is invalid.
    404InvalidDBInstance.NotFoundSpecified 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 timeSummary of changesOperation
    2023-11-07The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    2023-09-08The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2023-06-27The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ResourceGroupId