All Products
Search
Document Center

ApsaraDB RDS:CreateDBProxyEndpointAddress

Last Updated:Feb 29, 2024

Creates the endpoint that is used to connect to the dedicated proxy of an instance.

Operation description

Supported database engines

  • RDS MySQL
  • RDS PostgreSQL

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.

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:CreateDBProxyEndpointAddressWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DBInstanceIdstringYes

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

rm-t4n3axxxxx
DBProxyEndpointIdstringYes

The proxy endpoint ID. You can call the DescribeDBProxyEndpoint operation to query the proxy endpoint ID.

ta9um4xxxxx
ConnectionStringPrefixstringYes

The prefix of the proxy endpoint. Enter a custom prefix.

test1234
DBProxyNewConnectStringPortstringNo

The port number that is associated with the proxy endpoint.

  • If the instance runs MySQL, the default value is 3306.
  • If the instance runs PostgreSQL, the default value is 5432.
3306
DBProxyConnectStringNetTypestringYes

The network type of the proxy endpoint. Valid values:

  • Public: Internet
  • VPC: Virtual Private Cloud (VPC)
  • Classic: classic network

Default value: Classic

Public
VPCIdstringNo

The ID of the VPC to which the proxy endpoint belongs. You can call the DescribeDBInstanceAttribute operation to query the VPC ID.

Note This parameter must be specified when DBProxyConnectStringNetType is set to VPC.
vpc-bpxxxxxx
VSwitchIdstringNo

The ID of the vSwitch that is associated with the specified VPC. You can call the DescribeDBInstanceAttribute operation to query the vSwitch ID.

Note This parameter must be specified when DBProxyConnectStringNetType is set to VPC.
vsw-bpxxxxxx
DBProxyEngineTypestringNo

A reserved parameter. You do not need to specify this parameter.

normal
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

F2911788-25E8-42E5-A3A3-1B38D263F01E

Examples

Sample success responses

JSONformat

{
  "RequestId": "F2911788-25E8-42E5-A3A3-1B38D263F01E"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidPort.MalformedSpecified port is not valid.The port number is invalid.
400NetTypeExistsSpecified net type already existed.
400IncorrectDBInstanceNetTypeCurrent DB instance net type does not support this operation.The operation failed. The operation is not supported for the network type of the RDS instance.
400InvalidConnectionString.DuplicateSpecified connection string already exists in the Aliyun RDS.The endpoint is duplicate. Specify a different endpoint.
400InvalidConnVPCIdSpecified conn vpc id is not valid.The specified VPC ID is invalid.
400InvalidVpcInstanceIdSpecified vpc instance id is not valid.The specified VPC ID is invalid.
400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.
400InvalidVpcIdOrVswitchId.NotSupportedThe specified vpcId or vSwitchId is not supported.The VPC that is specified by the vpcId parameter or the vSwitch that is specified by the vSwitchId parameter is not supported. Check the values of these parameters.
400InvalidPrivateIpAddress.MismatchSpecified private IP address is not in the CIDR block of virtual switch.The VPC endpoint is invalid.
400InvalidVpcParameterSpecified VPCId VSwitchId or IPAddress or TunnelId is not valid.The values of the VPCId parameter and the VSwitchId parameter are invalid. Check the values of these parameters.
400InvalidBizType.FormatSpecified biz type is not valid.-
400InvalidVSwitchId.NotFoundSpecified vSwitch is not found in specified VPC.No vSwitch is found in the VPC.
400InvalidVSwitchId.MismatchSpecified instance and virtual switch are not in the same zone.The RDS instance and the vSwitch are not in the same zone.
400InvalidPrivateIpAddress.AlreadyUsedThe specified IP is already used.The IP address has been used.
400VswitchIpExhaustedNo available ip in the specified vswitch.No available IP address exists in the specified vSwitch.
400MaxscaleNotSupportCurrent custins can not support Maxscale.This operation is not supported for instances with maxscale.
400InvalidConnectionString.FormatSpecified connection string is not valid.The endpoint of the RDS instance is invalid. The prefix of the endpoint must be 5 to 40 characters in length.
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
403IncorrectKindCodeCurrent custins kindCode does not support this operation.The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
403IncorrectDBInstanceConnTypeCurrent DB instance conn type does not support this operation.The operation is not supported for the connection type of the RDS instance.
404Endpoint.NotFoundSpecified endpoint is not found.The port that is associated with the dedicated proxy endpoint cannot be found.
404Maxscale.NotFoundThe related maxscale instance is not found.The operation failed. No associated MaxScale instances can be found.
404IncorrectVswitchIdThe specified parameter VSwitchId is not valid.The vSwitch ID is invalid.
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.The instance ID cannot be found.
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.The RDS instance cannot be found, is deleted, or does not support the operation.
404InsufficientResourceCapacityCurrent cluster resources are insufficient. Try again later.Current cluster resources are insufficient. Try again later.

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

Change history

Change timeSummary of changesOperation
2023-12-19The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Error Codes 403 change
    Error Codes 404 change
2023-06-13The 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
2022-06-08The 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: DBProxyEngineType