All Products
Search

This Product

    ApsaraDB RDS:CreateDBInstanceEndpoint

    Document Center

    ApsaraDB RDS:CreateDBInstanceEndpoint

    Last Updated:Nov 11, 2024

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

    Operation description

    Supported database engines

    MySQL

    References

    Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

    Create a read-only endpoint for a cluster

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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:CreateDBInstanceEndpointcreate
    • 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 instance ID.

    		rm-****
    VpcIdstringYes

    The 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 endpoint type. 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
    NodeItemsarray<object>Yes

    The information about the endpoint.

    objectYes

    The information about the array object.

    DBInstanceIdstringYes

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

    		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 resource group ID. You can call the DescribeDBInstanceAttribute operation 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.-
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
    400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing 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.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
    400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
    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.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.The 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.Hello customer, this area has been abolished.
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Cloud 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.Commodity system call exception.
    400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There 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.There 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.Your basic information is not complete, please complete your basic information before operation.
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your 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.The current interface does not support.
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
    400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
    400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
    400KmsApiErrorUser secret key invalid.The user key is invalid.
    400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
    400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
    400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.SQL command execution failed or timed out
    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.-
    403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
    403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
    403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
    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.
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
    500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-11-07The Error code has changedView Change Details
    2023-09-08The Error code has changedView Change Details
    2023-06-27The Error code has changed. The request parameters of the API has changedView Change Details