Create a GA Endpoint Group for Low-Latency Routing via API - Global Accelerator - Alibaba Cloud - Global Accelerator

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

Operation description

CreateBasicEndpointGroup is an asynchronous operation. After you invoke this operation, the system returns an endpoint group ID before the endpoint group is created. The endpoint group is being created in the background. You can invoke GetBasicEndpointGroup to query the status of the endpoint group:
- If the endpoint group is in the init state, the endpoint group is being created. In this state, you can only perform query operations.
- If the endpoint group is in the active state, the endpoint group is created.
CreateBasicEndpointGroup does not support concurrent requests to create an endpoint group for 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:CreateBasicEndpointGroup

create

*BasicEndpointGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the basic Alibaba Cloud Global Accelerator (GA) 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 value as the ClientToken value. The RequestId value is 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****
EndpointGroupRegion	string	Yes	The region ID of the endpoint group for the basic Alibaba Cloud Global Accelerator (GA) instance. You can invoke the ListAvailableBusiRegions operation to query the region ID.	cn-shanghai
Name	string	No	The name of the endpoint group 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 (-).	group1
Description	string	No	The description of the endpoint group for the basic Alibaba Cloud Global Accelerator (GA) instance. The description can be up to 200 characters in length and cannot start with `http://` or `https://`.	BasicEndpointGroup
EndpointType	string	No	The endpoint type. Valid values: ENI: elastic network interface (ENI). SLB: Classic Load Balancer (CLB) instance. ECS: ECS instance.	ENI
EndpointAddress	string	No	The address of the endpoint.	eni-bp1a05txelswuj8g****
EndpointSubAddress	string	No	The secondary address of the endpoint. Specify this parameter when the accelerated IP address is associated with a secondary private IP address of an ECS instance or an ENI. If the endpoint type is ECS, EndpointSubAddress can be set to a secondary private IP address of the primary ENI. If this parameter is left empty, the primary private IP address of the primary ENI is used. If the endpoint type is ENI, EndpointSubAddress can be set to a secondary private IP address of the secondary ENI. If this parameter is left empty, the primary private IP address of the secondary ENI is used.	172.16.XX.XX

Response elements

Element	Type	Description	Example
	object	The response parameters.
EndpointGroupId	string	The ID of the endpoint group for the basic Alibaba Cloud Global Accelerator (GA) instance.	epg-bp1dmlohjjz4kqaun****
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Resource.QuotaFull	The resource quota is exceeded.	The number of resources has reached the upper limit.
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.	The current account does not have the permissions to enable health checks.
400	NotExist.Accelerator	The accelerated instance does not exist.	The GA instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.	The status of the GA instance is invalid.
400	NotExist.BusinessRegion	The business region does not exist.	The business region does not exist.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	You must specify the basic bandwidth package.
400	Exist.EndpointGroup	The endpoint group already exists.	The endpoint group already exists.
400	QuotaExceeded.EndpointGroup	The number of endpoint group exceeds the limit.	The number of endpoint groups has reached the upper limit.
400	EcsCannotBind.BasicEndpoint	The ECS instance has already been associated with another EIP.
400	InvalidateRegion.BasicAccelerator	The region of the endpoint group and the acceleration region cannot be the same.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	An error occurred while the request was being processed. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.