Batch-Provision Endpoints for a Basic GA Instance - Global Accelerator - Alibaba Cloud - Global Accelerator

Creates endpoints in a batch for a basic Global Accelerator (GA) instance.

Operation description

CreateBasicEndpoints is an asynchronous operation. After you call this operation, the system returns a request ID and runs the task in the background. You can call the ListBasicEndpoints operation to query the status of endpoints. - If one or more endpoints are in the init state, the endpoints are being created. You can continue to perform query operations on the endpoints. If all endpoints are in the active state, the endpoints are created.
You cannot call the CreateBasicEndpoints operation again on the same GA instance before the previous operation is complete.

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:CreateBasicEndpoints

create

*BasicEndpoint

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.	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 ensure 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
AcceleratorId	string	Yes	The ID of the basic GA instance.	ga-bp17frjjh0udz4qz****
EndpointGroupId	string	Yes	The ID of the endpoint group.	epg-bp1dmlohjjz4kqaun****
Endpoints	array<object>	Yes	The endpoints.
	object	No	The endpoints in the endpoint group.
Name	string	No	The name of the endpoint. 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
EndpointType	string	No	The type of the endpoint. Valid values: ENI: elastic network interface (ENI). SLB: Classic Load Balancer (CLB) instance. ECS: Elastic Compute Service (ECS) instance. NLB: Network Load Balancer (NLB) instance. Note This parameter is required.	ENI
EndpointAddress	string	No	The address of the endpoint.	eni-bp1a05txelswuj8g****
EndpointSubAddress	string	No	The secondary address of the endpoint. This parameter is required only if you set the endpoint type to ECS, ENI, or NLB. If you set the endpoint type to ECS, you can set EndpointSubAddress to the secondary private IP address of the primary ENI. If you leave this parameter empty, the primary private IP address of the primary ENI is used. If you set the endpoint type to ENI, you can set EndpointSubAddress to the secondary private IP address of the secondary ENI. If you leave this parameter empty, the primary private IP address of the secondary ENI is used. If you set the endpoint type to NLB, you can set EndpointSubAddress to the primary private IP address of the NLB backend server.	172.16.XX.XX
EndpointSubAddressType	string	No	The secondary address type of the endpoint. Valid values: primary: a primary private IP address. secondary: a secondary private IP address. This parameter is required only if you set the endpoint type to ECS, ENI, or NLB. If you set the endpoint type to NLB, only primary is supported.	primary
EndpointZoneId	string	No	The ID of the zone where the endpoint resides. This parameter is required only if you set the endpoint type to NLB.	cn-hangzhou-g

Response elements

Element	Type	Description	Example
	object	A list of response parameters.
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368
EndpointGroupId	string	The ID of the endpoint group.	epg-bp1dmlohjjz4kqaun****
Endpoints	array<object>	The endpoints in the endpoint group.
	object	The endpoints in the endpoint group.
EndpointId	string	The ID of the endpoint.	ep-bp14sz7ftcwwjgrdm****
EndpointType	string	The type of the endpoint. Valid values: ENI: ENI. SLB: CLB instance. ECS: ECS instance. NLB: NLB instance.	ENI
EndpointAddress	string	The address of the endpoint.	eni-bp1a05txelswuj8g****
EndpointSubAddress	string	The secondary address of the endpoint. This parameter is returned when the endpoint type is ECS, ENI, or NLB. If the endpoint type is ECS, EndpointSubAddress returns the primary or secondary private IP address of the primary ENI. If the endpoint type is ENI, EndpointSubAddress returns the primary or secondary private IP address of the secondary ENI. If the endpoint type is NLB, EndpointSubAddress returns the primary private IP address of the NLB backend server.	172.16.XX.XX

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "Endpoints": [
    {
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "EndpointType": "ENI",
      "EndpointAddress": "eni-bp1a05txelswuj8g****",
      "EndpointSubAddress": "172.16.XX.XX"
    }
  ]
}

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.
400	NotFound.ENIInstance	The ENI instance is not found.	The ENI instance does not exist in the region where the Endpoint Group belongs.
400	Invalidate.SlbAddressType	The SLB instance must be internal-facing.	The SLB instance must be internal-facing.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.