All Products
Search

This Product

    PolarDB:CreateDBEndpointAddress

    Document Center

    PolarDB:CreateDBEndpointAddress

    Last Updated:Dec 11, 2025

    Creates a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint of a PolarDB cluster.

    Operation description

    Note

    You can create a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint of a PolarDB cluster.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    polardb:CreateDBEndpointAddress

    create

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    pc-**************
    DBEndpointId

    string

    Yes

    The endpoint ID.

    Note

    For more information, see DescribeDBClusterEndpoints.

    pe-**************
    ConnectionStringPrefix

    string

    No

    The prefix of the new endpoint. The prefix must meet the following requirements:

    • Consist of lowercase letters, digits, and hyphens (-).

    • Start with a letter and end with a digit or a letter.

    • Be 6 to 40 characters in length.

    test-1
    NetType

    string

    Yes

    The network type of the new endpoint. Set the value to Public.

    Public
    VPCId

    string

    No

    The ID of the virtual private cloud (VPC).

    vpc-**********
    SecurityGroupId

    string

    No

    The ID of the ECS security group.

    sg-bp**************
    ZoneInfo

    array<object>

    No

    The zone information.

    object

    No

    ZoneId

    string

    No

    The zone ID.

    cn-hangzhou-b
    VSwitchId

    string

    No

    The virtual switch ID.

    vsw-**********

    Response elements

    Element

    Type

    Description

    Example

    object

    1

    RequestId

    string

    The request ID.

    6BD9CDE4-5E7B-4BF3-9BB8-83C73E******

    Examples

    Success response

    JSON format

    {
  "RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******"
}

    Error response

    JSON format

    {
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 EndpointStatus.NotSupport Current endpoint status does not support this operation.
    400 NetTypeExists Specified net type already existed. The specified network type already exists.
    400 MissParameter.NetType When NetType is set to NlbVpc, the VPCId, SecurityGroupId and ZoneInfo is needed. If NetType is set to NlbVpc, VPCId, SecurityGroupId and ZoneInfo must be specified.
    400 InvalidDBEndpointId.Malformed The specified parameter DBEndpointId is not valid. The specified DBEndpointId parameter is invalid.
    400 InvalidNetType.Malformed The specified parameter NetType is not valid. The specified NetType parameter is invalid.
    400 InvalidConnectionStringPrefix.Malformed The specified parameter ConnectionStringPrefix is not valid. The specified ConnectionStringPrefix parameter is invalid.
    404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist in the current record.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The specified DBClusterId parameter is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.