Modify Basic GA Endpoint Group Settings via API - Global Accelerator - Alibaba Cloud - Global Accelerator

Operation description

UpdateBasicEndpointGroup is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. The system modifies the configurations of an endpoint group that is associated with a basic GA instance by deleting the endpoint group and creating a new endpoint group. You can call the GetBasicAccelerator operation to query the status of the task.
- If the basic GA instance is in the configuring state, the configurations of the endpoint group are being modified. In this case, you can perform only query operations.
- If the basic GA instance is in the active state, the configurations of the endpoint group are modified.
The UpdateBasicEndpointGroup operation cannot be repeatedly called for the same basic GA instance within a specific period of time.

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

update

*BasicEndpointGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the basic 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 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
EndpointGroupId	string	Yes	The ID of the endpoint group.	epg-bp1dmlohjjz4kqaun****
Name	string	No	The name of the endpoint group. 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.	group1
Description	string	No	The description of the endpoint group. The description can be up to 200 characters in length and cannot start with `http://` or `https://`.	BasicEndpointGroup
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.	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 the accelerated IP address is associated with the secondary private IP address of an ECS instance or an ENI. 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.	172.16.XX.XX

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotExist.EndPointGroup	The endpoint group does not exist.	The endpoint group does not exist.
400	StateError.EndPointGroup	The specified state of endpoint group is invalid.	The endpoint group is in an invalid state.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.