Modifies one or more endpoint groups that are associated with a listener.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateEndpointGroups

The operation that you want to perform. Set the value to UpdateEndpointGroups.

RegionId String Yes cn-hangzhou

The region ID of the Global Accelerator (GA) instance. Set the value to cn-hangzhou.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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 make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

DryRun Boolean No true

Specifies whether to check the request but not perform the operation. Valid values:

  • true: checks the request but does not modify the specified endpoint groups. The system checks the required parameters, request syntax, and limits. If the request fails to pass the check, an error message is returned. If the request passes the check, the DryRunOperation error code is returned.
  • false (default): sends the request. If the request passes the check, a 2xx HTTP status code is returned and the endpoint groups are modified.
ListenerId String Yes lsr-bp1bpn0kn908w4nbw****

The ID of the listener.

EndpointGroupConfigurations.N.EndpointGroupName String No group1

The name of the endpoint group.

EndpointGroupConfigurations.N.EndpointGroupDescription String No group1

The description of the endpoint group.

EndpointGroupConfigurations.N.TrafficPercentage Long No 20

The traffic ratio for the endpoint group when the specified listener is associated with multiple endpoint groups.

Valid values: 1 to 100.

EndpointGroupConfigurations.N.HealthCheckEnabled Boolean No true

Specifies whether to enable the health check feature. Valid values:

  • true: enables the health check feature.
  • false (default): disables the health check feature.
EndpointGroupConfigurations.N.HealthCheckIntervalSeconds Long No 3

The interval between two consecutive health checks. Unit: seconds. Valid values: 1 to 50.

EndpointGroupConfigurations.N.HealthCheckPath String No /healthcheck

The path to which health check requests are sent.

EndpointGroupConfigurations.N.HealthCheckPort Long No 20

The port that is used for health checks.

Valid values: 1 to 65535.

EndpointGroupConfigurations.N.HealthCheckProtocol String No tcp

The protocol over which health check requests are sent. Valid values:

  • tcp: TCP
  • http: HTTP
  • https: HTTPS
EndpointGroupConfigurations.N.ThresholdCount Long No 3

The number of consecutive health check failures that must occur before a healthy endpoint is considered unhealthy, or the number of consecutive health check successes that must occur before an unhealthy endpoint is considered healthy.

Valid values: 2 to 10.

EndpointGroupConfigurations.N.EndpointConfigurations.N.Type String No Ip

The type of the endpoint. Valid values:

  • Domain: a custom domain name
  • Ip: a custom IP address
  • PublicIp: a public IP address provided by Alibaba Cloud
  • ECS: an Elastic Compute Service (ECS) instance
  • SLB: a Server Load Balancer (SLB) instance
  • ALB: an Application Load Balancer (ALB) instance
  • OSS: an Object Storage Service (OSS) bucket
Note
  • If you set this parameter to ECS or SLB and the service-linked role AliyunServiceRoleForGaVpcEndpoint does not exist, the system automatically creates the service-linked role.
  • If you set this parameter to ALB and the service-linked role AliyunServiceRoleForGaAlb does not exist, the system automatically creates the service-linked role.
  • If you set this parameter to OSS and the service-linked role AliyunServiceRoleForGaOss does not exist, the system automatically creates the service-linked role.

    For more information, see Service-linked roles.

EndpointGroupConfigurations.N.EndpointConfigurations.N.Weight Long No 20

The weight of the endpoint.

Valid values: 0 to 255.

EndpointGroupConfigurations.N.EndpointConfigurations.N.Endpoint String No 47.0.XX.XX

The IP address or domain name of the endpoint.

EndpointGroupConfigurations.N.EndpointRequestProtocol String No HTTP

The protocol that is used by the backend service. Valid values:

  • HTTP: HTTP
  • HTTPS: HTTPS
EndpointGroupConfigurations.N.PortOverrides.N.ListenerPort Long No 443

The listener port.

Valid values: 1 to 65499.

EndpointGroupConfigurations.N.PortOverrides.N.EndpointPort Long No 80

The endpoint port.

Valid values: 1 to 65499.

EndpointGroupConfigurations.N.EnableClientIPPreservationToa Boolean No false

Specifies whether to use the TCP Option Address (TOA) module to preserve client IP addresses. Valid values:

  • true: yes
  • false: no
EndpointGroupConfigurations.N.EnableClientIPPreservationProxyProtocol Boolean No false

Specifies whether to use the proxy protocol to preserve client IP addresses. Valid values:

  • true: yes
  • false: no
EndpointGroupConfigurations.N.EndpointGroupId String Yes ep-bp1d2utp8qqe2a44t****

The ID of the endpoint.

Response parameters

Parameter Type Example Description
RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

The ID of the request.

EndpointGroupIds Array of String ['epg-bp1dmlohjjz4kqaun****','epg-bp1v1u72cx35ogofe****', ...]

The IDs of the endpoint groups.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateEndpointGroups
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&DryRun=true
&EndpointGroupConfigurations=[{"EndpointGroupName":"group1","EndpointGroupDescription":"group1","TrafficPercentage":20,"HealthCheckEnabled":true,"HealthCheckIntervalSeconds":3,"HealthCheckPath":"/healthcheck","HealthCheckPort":20,"HealthCheckProtocol":"tcp","ThresholdCount":3,"EndpointConfigurations":[{"Type":"Ip","Weight":20,"Endpoint":"47.0.XX.XX"}],"EndpointRequestProtocol":"HTTP","PortOverrides":[{"ListenerPort":443,"EndpointPort":80}],"EnableClientIPPreservationToa":false,"EnableClientIPPreservationProxyProtocol":false,"EndpointGroupId":"ep-bp1d2utp8qqe2a44t****"}]
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateEndpointGroupsResponse>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>
    <EndpointGroupIds>['epg-bp1dmlohjjz4kqaun****','epg-bp1v1u72cx35ogofe****', ...]</EndpointGroupIds>
</UpdateEndpointGroupsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 NotExist.EndPointGroup The endpoint group does not exist. The error message returned because the specified endpoint group does not exist.
400 StateError.EndPointGroup The specified state of endpoint group is invalid. The error message returned because the specified endpoint group is in an invalid state.
400 NotExist.Listener The listener does not exist. The error message returned because the specified listener does not exist.
400 NotActive.Listener The state of the listener is not active. The error message returned because the specified listener is unstable.
400 NotExist.Accelerator The accelerated instance does not exist. The error message returned because the specified GA instance does not exist.
400 StateError.Accelerator The state of the accelerated instance is invalid. The error message returned because the specified GA instance is in an invalid state.
400 QuotaExceeded.EndPoint The maximum number of endpoints is exceeded. The error message returned because the number of endpoints has reached the upper limit.
400 NoPermission.VpcEndpoint You are not authorized to perform the operation. The error message returned because you are unauthorized to create the service-linked role. Contact the owner of the Alibaba Cloud account or the administrator to acquire the AliyunGlobalAccelerationFullAccess permission or create a custom permission policy. The service name of the custom permission policy must be vpcendpoint.ga.aliyuncs.com, the service-linked role must be AliyunServiceRoleForGaVpcEndpoint, and the ram:CreateServiceLinkedRole permission must be granted.
400 QuotaExceeded.PortOverride The number of port override exceeds the limit. The error message returned because the number of port mappings has reached the upper limit.

For a list of error codes, visit the API Error Center.