All Products
Search

This Product

    Global Accelerator:CreateBasicEndpoint

    Document Center

    Global Accelerator:CreateBasicEndpoint

    Last Updated:Jun 30, 2026

    Invokes the CreateBasicEndpoint operation to create an endpoint for a basic Alibaba Cloud Global Accelerator (GA) instance.

    Operation description

    • CreateBasicEndpoint is an asynchronous operation. After you invoke this operation, the system returns an endpoint ID for the basic Alibaba Cloud Global Accelerator (GA) instance, but the endpoint is not yet created. The creation task continues to execute in the background. You can invoke ListBasicEndpoints to query the endpoint status:

      • When the endpoint is in the init state, the endpoint is being created. In this state, you can only execute query operations.

      • When the endpoint is in the active state, the endpoint is created.

    • CreateBasicEndpoint does not support concurrent endpoint creation within the same basic Alibaba Cloud Global Accelerator (GA) instance.

    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

    ga:CreateBasicEndpoint

    create

    *BasicEndpoint

    acs:ga:{#regionId}:{#accountId}:basicendpoint/*

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID of the Global Accelerator instance. Set the value to ap-southeast-1.

    cn-hangzhou
    ClientToken

    string

    No

    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 client token can contain only ASCII characters.

    Note

    If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.

    123e4567-e89b-12d3-a456-426655440000
    AcceleratorId

    string

    Yes

    The instance ID of the basic Alibaba Cloud Global Accelerator (GA).

    ga-bp17frjjh0udz4qz****
    EndpointGroupId

    string

    Yes

    The endpoint group ID of the basic Alibaba Cloud Global Accelerator (GA) instance.

    epg-bp1dmlohjjz4kqaun****
    Name

    string

    No

    The name of the endpoint for the basic Alibaba Cloud Global Accelerator (GA) instance.

    The name must be 1 to 128 characters in length and must start with a letter or a Chinese character. The name can contain digits, periods (.), underscores (_), and hyphens (-).

    ep01
    EndpointType

    string

    Yes

    The endpoint type. Valid values:

    • ENI: Alibaba Cloud elastic network interface (ENI).

    • SLB: Alibaba Cloud Classic Load Balancer (CLB) instance.

    • ECS: Alibaba Cloud ECS instance.

    • NLB: Alibaba Cloud Network Load Balancer (NLB) instance.

    ENI
    EndpointAddress

    string

    Yes

    The address of the endpoint.

    eni-bp1a05txelswuj8g****
    EndpointSubAddress

    string

    No

    The secondary address of the endpoint.

    This parameter is required when the endpoint type is ECS, ENI, or NLB.

    • If the endpoint type is ECS, EndpointSubAddress can be set to a secondary private IP of the primary network interface controller (NIC). If you leave this parameter empty, the primary private IP of the primary network interface controller (NIC) is used.

    • If the endpoint type is ENI, EndpointSubAddress can be set to a secondary private IP of the secondary network interface controller (NIC). If you leave this parameter empty, the primary private IP of the secondary network interface controller (NIC) is used.

    • If the endpoint type is NLB, this parameter is required. Set EndpointSubAddress to the primary private IP of the NLB backend server.

    172.16.XX.XX
    EndpointSubAddressType

    string

    No

    The type of the secondary address of the endpoint. Valid values:

    • primary: The secondary address type is the primary private IP address.

    • secondary: The secondary address type is a secondary private IP address.

    This parameter is required when the endpoint type is ECS, ENI, or NLB. If the endpoint type is NLB, only primary is supported.

    primary
    EndpointZoneId

    string

    No

    The zone ID of the endpoint.

    Currently, this parameter is required only when the endpoint type is NLB.

    cn-hangzhou-g

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    04F0F334-1335-436C-A1D7-6C044FE73368
    EndpointGroupId

    string

    The endpoint group ID of the basic Alibaba Cloud Global Accelerator (GA) instance.

    epg-bp1dmlohjjz4kqaun****
    EndpointId

    string

    The endpoint ID of the basic Alibaba Cloud Global Accelerator (GA) instance.

    ep-bp14sz7ftcwwjgrdm****

    Examples

    Success response

    JSON format

    {
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "EndpointId": "ep-bp14sz7ftcwwjgrdm****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 NotExist.Accelerator The accelerated instance does not exist. The GA instance does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.