All Products
Search
Document Center

Global Accelerator:CreateBasicEndpoint

Last Updated:May 16, 2024

Creates an endpoint for a basic Global Accelerator (GA) instance.

Operation description

  • CreateBasicEndpoint is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the ListBasicEndpoints API operation to query the status of an endpoint.

    • If the endpoint is in the init state, the endpoint is being created. In this case, you can perform only query operations.
    • If the endpoint is in the active state, the endpoint is created.
  • The CreateBasicEndpoint API operation cannot be repeatedly called for the same basic GA instance within a specific period of time.

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
ga:CreateBasicEndpointWrite
  • BasicEndpoint
    acs:ga:{#regionId}:{#accountId}:basicendpoint/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.

cn-hangzhou
ClientTokenstringNo

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

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
123e4567-e89b-12d3-a456-426655440000
AcceleratorIdstringYes

The ID of the basic GA instance.

ga-bp17frjjh0udz4qz****
EndpointGroupIdstringYes

The ID of the endpoint group.

epg-bp1dmlohjjz4kqaun****
NamestringNo

The name of the endpoint that is associated with the basic GA instance.

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

ep01
EndpointTypestringYes

The type of endpoint. Valid values:

  • ENI: elastic network interface (ENI)
  • SLB: Classic Load Balancer (CLB)
  • ECS: Elastic Compute Service (ECS)
  • NLB: Network Load Balancer (NLB)
ENI
EndpointAddressstringYes

The address of the endpoint.

eni-bp1a05txelswuj8g****
EndpointSubAddressstringNo

The secondary address of the endpoint.

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

  • If the endpoint type is ECS, you can set EndpointSubAddress to the secondary private IP address of the primary ENI. If the parameter is left empty, the primary private IP address of the primary ENI is used.
  • If the endpoint type is ENI, you can set EndpointSubAddress to the secondary private IP address of the secondary ENI. If the parameter is left empty, the primary private IP address of the secondary ENI is used.
  • This parameter is required if the endpoint type is NLB. EndpointSubAddress is the primary private IP address of the NLB backend server.
172.16.XX.XX
EndpointSubAddressTypestringNo

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

  • primary: a primary private IP address.
  • secondary: a secondary private IP address.

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

primary
EndpointZoneIdstringNo

The zone ID of the endpoint.

This parameter is required only if the endpoint type is NLB.

cn-hangzhou-g

Response parameters

ParameterTypeDescriptionExample
object

The list of response parameters.

RequestIdstring

The ID of the request.

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

The ID of the endpoint group.

epg-bp1dmlohjjz4kqaun****
EndpointIdstring

The ID of the endpoint.

ep-bp14sz7ftcwwjgrdm****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400NotExist.AcceleratorThe accelerated instance does not exist.The GA instance does not exist.

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

Change history

Change timeSummary of changesOperation
2023-04-20The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400