Update Endpoint Group Settings via UpdateEndpointGroup API - Global Accelerator - Alibaba Cloud - Global Accelerator

Modifies the configuration of an endpoint group.

Operation description

UpdateEndpointGroup operation is asynchronous. After you send a request, the system returns a request ID, but the operation is still being performed in the background. You can call the DescribeEndpointGroup operation to query the state of an endpoint group:
- If the endpoint group is in the updating state, its configuration is being modified. In this state, you can only perform query operations.
- If the endpoint group is in the active state, its configuration is modified.
The UpdateEndpointGroup operation does not support concurrent modifications to endpoint groups within the same Global Accelerator 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:UpdateEndpointGroup

update

*EndpointGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator 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. Generate a parameter value from your client to make sure that the value 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 request as the ClientToken. The RequestId 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, start with a letter or a Chinese character, and can contain digits, periods (.), underscores (_), and hyphens (-).	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://`.	EndpointGroup
EndpointGroupRegion	string	Yes	The ID of the region to which the endpoint group belongs.	cn-hangzhou
TrafficPercentage	integer	No	The weight of the endpoint group when the listener is associated with multiple endpoint groups.	20
HealthCheckIntervalSeconds	integer	No	The interval at which health checks are performed. Unit: seconds. The value must be in the range of 1 to 50.	3
HealthCheckPath	string	No	The path for health checks.	/healthcheck
HealthCheckPort	integer	No	The port that is used for health checks. The value must be in the range of 1 to 65535.	20
HealthCheckProtocol	string	No	The protocol that is used for health checks. Valid values: tcp or TCP: TCP http or HTTP: HTTP https or HTTPS: HTTPS	HTTPS
ThresholdCount	integer	No	The number of consecutive health checks that must succeed or fail before the health check status of the endpoint changes from healthy to unhealthy, or vice versa. The value must be in the range of 2 to 10.	3
EndpointConfigurations	array<object>	No	The configurations of the endpoints.
	object	No	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 address. PublicIp: an Alibaba Cloud public IP address. ECS: an Alibaba Cloud Elastic Compute Service (ECS) instance. SLB: an Alibaba Cloud Server Load Balancer (SLB) instance. ALB: an Alibaba Cloud Application Load Balancer (ALB) instance. OSS: an Alibaba Cloud Object Storage Service (OSS) bucket. ENI: an Alibaba Cloud Elastic Network Interface (ENI). NLB: an Alibaba Cloud Network Load Balancer (NLB) instance. Note If you set the endpoint type to ECS, ENI, SLB, ALB, NLB, or IpTarget, and the service-linked role AliyunServiceRoleForGaVpcEndpoint does not exist, the system automatically creates the service-linked role. If you set the endpoint type to ALB and the service-linked role AliyunServiceRoleForGaAlb does not exist, the system automatically creates the service-linked role. If you set the endpoint type to OSS and the service-linked role AliyunServiceRoleForGaOss does not exist, the system automatically creates the service-linked role. If you set the endpoint type to NLB and the service-linked role AliyunServiceRoleForGaNlb does not exist, the system automatically creates the service-linked role. Note For more information, see Service-linked roles.	Ip
EnableClientIPPreservation	boolean	No	Specifies whether to preserve client IP addresses. Valid values: true: Preserves client IP addresses. false (default): Does not preserve client IP addresses. Note By default, client IP addresses are not preserved for endpoint groups of TCP or UDP listeners. You can enable this feature as needed. For endpoint groups of HTTP or HTTPS listeners, client IP addresses are preserved by default. The client IP addresses are stored in 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.	false
Weight	integer	Yes	The weight of the endpoint. The value must be in the range of 0 to 255. Note If you set the weight of an endpoint to 0, Global Accelerator stops distributing traffic to the endpoint. Handle this with care.	20
EnableProxyProtocol	boolean	No	Specifies whether to use the proxy protocol to preserve client IP addresses. Valid values: true: Preserves client IP addresses. false (default): Does not preserve client IP addresses. Note This parameter is available only for endpoint groups of TCP listeners. You cannot set both EnableClientIPPreservation and EnableProxyProtocol to true. For more information, see Preserve client IP addresses.	false
Endpoint	string	Yes	The IP address, domain name, or instance ID of the endpoint, based on the value of Type.	120.XX.XX.21
SubAddress	string	No	The private IP address of the ENI. Note When 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.	172.168.XX.XX
VpcId	string	No	The ID of the virtual private cloud (VPC). You can specify up to one VPC for an endpoint group that is associated with a listener that uses smart routing. Note This parameter is required and valid only when the endpoint type is IpTarget.	vpc-2zen6t0u7xhm0k5iz****
VSwitchIds	array	No	The list of vSwitches in the VPC.
	string	No	The ID of the vSwitch. You can specify up to two vSwitches for an endpoint group that is associated with a listener that uses smart routing. Note This parameter is required and valid only when the endpoint type is IpTarget. The vSwitch must belong to the VPC specified by the VpcId parameter.	vsw-2ze2dbtkxabpvpqxc****
EndpointRequestProtocol	string	No	The protocol of the backend service. Valid values: HTTP HTTPS Note This parameter is available only when you create an endpoint group for an HTTP or HTTPS listener. For an HTTP listener, the backend service protocol must be HTTP.	HTTP
EndpointProtocolVersion	string	No	The version of the backend service protocol. Valid values: HTTP1.1 HTTP2 Note This parameter is available only when the EndpointRequestProtocol is set to HTTPS.	HTTP1.1
PortOverrides	array<object>	No	The port mapping.
	object	No	The port mapping.
ListenerPort	integer	No	The listener port in the port mapping. Note For TCP listeners, virtual endpoint groups do not support port mappings. If a listener is associated with a virtual endpoint group, you cannot configure port mappings for the default endpoint group. If you configure port mappings for the default endpoint group, you cannot add a virtual endpoint group. After you configure a port mapping, you cannot change the listener protocol, except for switching between HTTP and HTTPS. Listener port: The modified listener port range must include all listener ports that are configured in the port mapping. For example, if the listener port range is 80-82 and the port mapping maps listener ports to endpoint ports 100-102, you cannot change the listener port range to 80-81.	443
EndpointPort	integer	No	The endpoint port in the port mapping.	80
HealthCheckEnabled	boolean	No	Specifies whether to enable the health check feature. Valid values: true: Enables the health check feature. false (default): Disables the health check feature.	true
HealthCheckHost	string	No

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	6FEA0CF3-D3B9-43E5-A304-D217037876A8

Examples

Success response

JSON format

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}

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.