All Products
Search

This Product

    PolarDB:AllocateInstancePublicConnection

    Document Center

    PolarDB:AllocateInstancePublicConnection

    Last Updated:Mar 30, 2026

    Creates a public endpoint for a PolarDB-X instance.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. Call this operation in OpenAPI Explorer to generate sample code for different SDKs.

    Request parameters

    Parameter

    Type

    Required

    Example

    Description

    Action

    String

    No

    AllocateInstancePublicConnection

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

    DBInstanceName

    String

    Yes

    pxc-\*\*\*\*\*\*\*\*\*\*\*\*\*\*

    The name of the instance.

    ConnectionStringPrefix

    String

    Yes

    pxc-\*\*\*\*\*\*\*\*\*\*\*\*\*\*

    The prefix of the public endpoint.

    Port

    String

    Yes

    3306

    The port number of the public endpoint.

    RegionId

    String

    No

    cn-hangzhou

    The region where the PolarDB-X instance resides.

    Response parameters

    Parameter

    Type

    Example

    Description

    RequestId

    String

    9B2F3840-5C98-475C-B269-2D5C3A31797C

    The request ID.

    Examples

    Sample requests

    http(s)://[Endpoint]/?Action=AllocateInstancePublicConnection
&DBInstanceName=pxc-**************
&ConnectionStringPrefix=pxc-**************
&Port=3306
&RegionId=cn-hangzhou
&<Common request parameters>

    Sample success responses

    XML format

    HTTP/1.1 200 OK
Content-Type:application/xml

<AllocateInstancePublicConnectionResponse>
    <RequestId>9B2F3840-5C98-475C-B269-2D5C3A31797C</RequestId>
</AllocateInstancePublicConnectionResponse>

    JSON format

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "9B2F3840-5C98-475C-B269-2D5C3A31797C"
}

    Error codes

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