Global Accelerator:UpdateEndpointGroups - Global Accelerator - Alibaba Cloud - Global Accelerator

Updates endpoint groups under a listener in batches.

Operation description

Usage notes

The UpdateEndpointGroups operation is asynchronous. The system returns a request ID, but the endpoint group configurations are not immediately updated. The update task continues to run in the background. You can invoke the DescribeEndpointGroup or ListEndpointGroups operation to query the status of the endpoint groups:
- If the endpoint group is in the updating state, the endpoint group configurations are being updated. In this state, you can only execute query operations.
- If the endpoint group is in the active state, the endpoint group configurations are updated.
The UpdateEndpointGroups operation does not support concurrent updates to endpoint group configurations within the same 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:UpdateEndpointGroups

update

*EndpointGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. 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 value, but you must ensure that it 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 of each API request is unique.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run. The system checks the request without updating the endpoint groups. The system checks whether the required parameters are specified, the request format is valid, and the service limits are met. If the request fails the dry run, an error message is returned. If the request passes the dry run, an HTTP 2xx status code is returned. false (default): Performs a dry run and then sends the request. If the request passes the dry run, an HTTP 2xx status code is returned and the system updates the endpoint groups.	true
EndpointGroupConfigurations	array<object>	Yes	The configurations of the endpoint groups.
	array<object>	No	The configurations of the endpoint groups.
EndpointGroupName	string	No	The name of the endpoint group. The name must be 1 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter or a Chinese character.	group1
EndpointGroupDescription	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://.	group1
TrafficPercentage	integer	No	The traffic percentage that is distributed to the endpoint group when the listener has multiple endpoint groups. Valid values: 1 to 100.	20
HealthCheckEnabled	boolean	No	Specifies whether to enable health checks. Valid values: true: Enables health checks. false (default): Disables health checks.	true
HealthCheckIntervalSeconds	integer	No	The interval between two consecutive health checks. Unit: seconds. Valid values: 1 to 50.	3
HealthCheckPath	string	No	The health check path.	/healthcheck
HealthCheckPort	integer	No	The port for health checks. Valid values: 1 to 65535.	20
HealthCheckProtocol	string	No	The protocol for health checks. Valid values: tcp or TCP: TCP http or HTTP: HTTP https or HTTPS: HTTPS	tcp
ThresholdCount	integer	No	The number of consecutive health checks that are required to change the health check status. This refers to the number of consecutive failed health checks required to change the status from healthy to unhealthy, or the number of consecutive successful health checks required to change the status from unhealthy to healthy. Valid values: 2 to 10.	3
EndpointConfigurations	array<object>	No	The configurations of the endpoints.
	object	Yes	The configurations of the endpoints.
Type	string	Yes	The type of the endpoint. Valid values: Domain: a custom domain name. Ip: a custom IP address. IpTarget: a custom private IP. PublicIp: an Alibaba Cloud public IP address. ECS: an Alibaba Cloud ECS instance. SLB: an Alibaba Cloud SLB instance. ALB: an Alibaba Cloud ALB instance. OSS: an Alibaba Cloud OSS instance. ENI: an Alibaba Cloud elastic network interface (ENI). NLB: an Alibaba Cloud NLB instance. Note If the endpoint type is set to ECS, ENI, SLB, ALB, NLB, or IpTarget, and the service-linked role does not exist, the system automatically creates a service-linked role named AliyunServiceRoleForGaVpcEndpoint. If the endpoint type is set to ALB, and the service-linked role does not exist, the system automatically creates a service-linked role named AliyunServiceRoleForGaAlb. If the endpoint type is set to OSS, and the service-linked role does not exist, the system automatically creates a service-linked role named AliyunServiceRoleForGaOss. Note For more information, see Service-linked roles.	Ip
Weight	integer	Yes	The weight of the endpoint. Valid values: 0 to 255. Note If the weight of an endpoint is set to 0, Global Accelerator stops distributing traffic to the endpoint. Proceed with caution.	20
Endpoint	string	Yes	The IP address, domain name, or instance ID of the endpoint. Specify the value based on the endpoint type.	47.0.XX.XX
SubAddress	string	No	The private IP address of the elastic network interface (ENI). Note If the endpoint type is ENI, you can specify this parameter. If you do not specify this parameter, the primary private IP address of the ENI is used by default.	172.168.XX.XX
EnableClientIPPreservation	boolean	No	Specifies whether to enable client IP address preservation by using the automatic retrieval method. Valid values: true: Enables client IP address preservation. false (default): Disables client IP address preservation. Note By default, client IP address preservation is disabled for endpoint groups associated with UDP or TCP listeners. You can configure this feature based on your business requirements. By default, client IP address preservation is enabled for endpoint groups associated with HTTP or HTTPS listeners. The client IP address is obtained from the X-Forwarded-For header. You cannot disable this feature. You cannot set both EnableClientIPPreservation and EnableProxyProtocol to true. For more information, see Preserve client IP addresses.
EnableProxyProtocol	boolean	No	Specifies whether to enable client IP address preservation by using the Proxy Protocol. Valid values: true: Enables client IP address preservation. false (default): Disables client IP address preservation. Note This parameter is supported only for endpoint groups associated with TCP listeners. You cannot set both EnableClientIPPreservation and EnableProxyProtocol to true. For more information, see Preserve client IP addresses.
VpcId	string	No	The ID of the virtual private cloud (VPC). You can specify at most one VPC ID for an endpoint group associated with an intelligent routing listener. Note This parameter is required and takes effect only when the endpoint type is set to IpTarget.	vpc-uf66oesmrqge1t2gs****
VSwitchIds	array	No	The vSwitches in the VPC.
	string	No	The ID of the vSwitch. You can specify at most two vSwitch IDs for an endpoint group associated with an intelligent routing listener. Note This parameter is required and takes effect only when the endpoint type is set to IpTarget. The vSwitch must belong to the VPC specified by the VpcId parameter.	vsw-uf6r0due94mypz1i9****
Provider	string	No	The service provider of the endpoint configuration.	BAILIAN
ApiKeys	array	No	The API keys in the endpoint group configuration.
	string	No	The API keys in the endpoint group configuration.	sk-*******
EndpointRequestProtocol	string	No	The protocol for the backend service. Valid values: HTTP: HTTP. HTTPS: HTTPS. Note You can specify this parameter only when you create an endpoint group for an HTTP or HTTPS listener instance. For an HTTP listener instance, the protocol for the backend service supports and only supports HTTP.	HTTP
EndpointProtocolVersion	string	No	The version of the protocol for the backend service for the endpoint associated with an intelligent routing listener. Valid values: HTTP1.1 (default): HTTP/1.1. HTTP2: HTTP/2. Note You can specify the version of the protocol for the backend service only when the EndpointRequestProtocol parameter is set to HTTPS.	HTTP1.1
PortOverrides	array<object>	No	The port mappings.
	object	No	The port mappings.
ListenerPort	integer	No	The listener port. Valid values: 1 to 65499. Note For TCP listeners: Port mappings are not supported for virtual endpoint groups. If a virtual endpoint group already exists under the listener, you cannot configure port mappings for the default endpoint group. If port mappings are already configured for the default endpoint group, you cannot add a virtual endpoint group. After you configure port mappings, the following limits apply to subsequent listener modifications: You cannot modify the listener protocol, except for switching between HTTP and HTTPS. Listener port: The modified listener port range must include all listener ports configured in the current port mappings. For example, if the listener port range is 80 to 82 and port mappings are configured to endpoint ports 100 to 102, you cannot change the listener port range to 80 to 81.	443
EndpointPort	integer	No	The endpoint port. Valid values: 1 to 65499.	80
EnableClientIPPreservationToa	boolean	No	Specifies whether to use the TCP Option Address (TOA) method to preserve the client IP address. Valid values: true: Yes. false: No.	false
EnableClientIPPreservationProxyProtocol	boolean	No	Specifies whether to use the Proxy Protocol to preserve the client IP address. Valid values: true: Yes. false: No.	false
EndpointGroupId	string	Yes	The endpoint group ID.	ep-bp1d2utp8qqe2a44t****
HealthCheckHost	string	No	The domain name for health checks.	www.taobao.com
EndpointIpVersion	string	No	The IP version of the backend service. Valid values: IPv4 (default): GA communicates with the endpoint service only by using IPv4 addresses. IPv6: GA communicates with the endpoint service only by using IPv6 addresses. ProtocolAffinity: GA uses the same IP version to communicate with the endpoint service as the IP version used by the client request.	IPv4
ProxyTunnel	object	No	The proxy tunnel configuration.
ConnectAuthPrefix	string	No	The proxy tunnel connection authentication prefix.	prefix-auth
ConnectAuthSuffix	string	No	The proxy tunnel connection authentication suffix.	suffix-auth
ConnectSessionHashHdr	string	No	The connection session hash header configuration.	X-Session-Hash
ConnectTunnelTimeout	integer	No	The proxy tunnel connection timeout period.	5000
TunnelServerPort	integer	No	The tunnel server port.	8443
TunnelServerType	string	No	The tunnel server type.	domain
TunnelServer	string	No	The tunnel server configuration.	tunnel.example.com
HealthCheckMethod	string	No	The health check method of the endpoint group.	GET
HealthCheckSuccessCodes	string	No	The success status codes for health checks.	http_2xx,http_3xx
ListenerId	string	Yes	The listener instance ID.	lsr-bp1bpn0kn908w4nbw****

Response elements

Element	Type	Description	Example
	object	The returned information.
RequestId	string	The request ID.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIds	array	The list of endpoint group IDs.
	string	The endpoint group ID.	epg-bp1dmlohjjz4kqaun****

Examples

Success response

JSON format

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "EndpointGroupIds": [
    "epg-bp1dmlohjjz4kqaun****"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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.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.Listener	The listener does not exist.	The listener does not exist.
400	NotActive.Listener	The state of the listener is not active.	The listener is unstable.
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	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	The maximum number of endpoints is exceeded.
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.	The user does not have permissions to create service linked roles. Contact the Alibaba Cloud account owner or the permission administrator to grant the current user AliyunGlobalAccelerationFullAccess or create custom permission policies for service linked role. The following content describes the detailed information about custom permission policies: ServiceName: vpcendpoint.ga.aliyuncs.com. Service linked role name: AliyunServiceRoleForGaVpc. Endpoint Permission: ram:CreateServiceLinkedRole.
400	EndPointRequestProtocolIllegal.EndpointGroup	endpoint group request protoco is illegal
400	QuotaExceeded.PortOverride	The number of port override exceeds the limit.	The number of port override exceeds the limit.
400	NotExist.ListenerPort	listener port %s is not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.