You can call the CreateDBProxyEndpointAddress operation to create an endpoint that is used to connect to the dedicated proxies of an instance.

After you enable the dedicated proxy feature for an instance, the system generates a default endpoint that is used to connect to the dedicated proxies of the instance. However, you can call this operation to create another endpoint of the specified network type.

Note
  • If the instance uses local SSDs, three network types are supported: VPC, Classic, and Public.
  • If the instance uses standard or enhanced SSDs, two network types are supported: VPC and Public.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateDBProxyEndpointAddress

The operation that you want to perform. Set the value to CreateDBProxyEndpointAddress.

RegionId String Yes cn-hangzhou

The ID of the region to which the instance belongs. You can call the DescribeRegions operation to query the most recent region list.

DBInstanceId String Yes rm-t4n3axxxxx

The ID of the instance.

DBProxyEndpointId String Yes ta9um4xxxxx

The ID of the endpoint.

DBProxyConnectStringNetType String Yes Public

The network type of the endpoint. Valid values:

  • Public
  • VPC
  • Classic

Default value: Classic.

ConnectionStringPrefix String Yes test1234

The prefix of the endpoint.

DBProxyNewConnectStringPort String No 3306

The port associated with the endpoint. Default value: 3306.

VPCId String No vpc-bpxxxxxx

The ID of the VPC to which the endpoint belongs.

Note When you set the DBProxyConnectStringNetType parameter to VPC, you must specify the VPCId parameter.
VSwitchId String No vsw-bpxxxxxx

The ID of the VSwitch associated with the specified VPC.

Note When you set the DBProxyConnectStringNetType parameter to VPC, you must specify the VSwitchId parameter.

Response parameters

Parameter Type Example Description
RequestId String F2911788-25E8-42E5-A3A3-1B38D263F01E

The ID of the request.

Examples

Sample requests

http(s)://rds.aliyuncs.com/? Action=CreateDBProxyEndpointAddress
&RegionId=cn-hangzhou
&DBInstanceId=m-t4n3axxxxx
&DBProxyEndpointId=ta9um4xxxxx
&DBProxyConnectStringNetType=Public
&ConnectionStringPrefix=test1234
&<Common request parameters>

Sample success responses

XML format

<CreateDBProxyEndpointAddressResponse>
  <RequestId>F2911788-25E8-42E5-A3A3-1B38D263F01E</RequestId>
</CreateDBProxyEndpointAddressResponse>

JSON format

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

Error codes

HTTP status code Error code Error message Description
400 InvalidPort.Malformed Specified port is not valid. The error message returned because the specified port is invalid.
400 NetTypeExists Specified net type already existed. The error message returned because an endpoint of the specified network type already exists. Check whether the specified network type is correct.
400 InvalidConnectionString.Duplicate Specified connection string already exists in the Aliyun RDS. The error message returned because the specified endpoint already exists in ApsaraDB for RDS.

For a list of error codes, visit the API Error Center.