Modifies the configuration of an endpoint group.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | UpdateEndpointGroup |
The operation that you want to perform. Set the value to UpdateEndpointGroup. |
RegionId | String | Yes | cn-hangzhou |
The ID of the region where the Global Accelerator (GA) instance is deployed. 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 ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. |
EndpointGroupId | String | Yes | epg-bp1dmlohjjz4kqaun**** |
The ID of the endpoint group. |
Name | String | No | group1 |
The name of the endpoint group. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter. |
Description | String | No | EndpointGroup |
The description of the endpoint group. |
EndpointGroupRegion | String | Yes | cn-hangzhou |
The ID of the region where the endpoint group is deployed. |
TrafficPercentage | Integer | No | 20 |
The weight of the endpoint group when the listener is associated with multiple endpoint groups. |
HealthCheckIntervalSeconds | Integer | No | 3 |
The interval at which health checks are performed. Unit: seconds. |
HealthCheckPath | String | No | /healthcheck |
The path to which health check requests are sent. |
HealthCheckPort | Integer | No | 20 |
The port used for health checks. |
HealthCheckProtocol | String | No | tcp |
The protocol over which health check requests are sent. Valid values:
|
ThresholdCount | Integer | No | 3 |
The number of consecutive failed heath checks that must occur before an endpoint is considered unhealthy. |
EndpointRequestProtocol | String | No | HTTP |
The protocol used by the backend service. Valid values:
Note
|
HealthCheckEnabled | Boolean | No | true |
Specifies whether to enable the health check feature. Valid values:
|
EndpointConfigurations.N.Type | String | Yes | Ip |
The type of the endpoint. Valid values:
Note
For more information, see Service-linked roles. |
EndpointConfigurations.N.EnableClientIPPreservation | Boolean | No | false |
Specifies whether to preserve client IP addresses. Valid values:
|
EndpointConfigurations.N.Weight | Integer | Yes | 20 |
The weight of the endpoint. Valid values: 0 to 255. Note If you set the weight of an endpoint to 0, GA stops routing network traffic to the
endpoint. Proceed with caution.
|
EndpointConfigurations.N.Endpoint | String | Yes | 120.XX.XX.21 |
The IP address or domain name of the endpoint. |
PortOverrides.N.ListenerPort | Integer | No | 443 |
The listener port that is mapped to the endpoint port. Note
|
PortOverrides.N.EndpointPort | Integer | No | 80 |
The endpoint port that is mapped to the listener port. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 6FEA0CF3-D3B9-43E5-A304-D217037876A8 |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=UpdateEndpointGroup
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&EndpointGroupId=epg-bp1dmlohjjz4kqaun****
&Name=group1
&Description=EndpointGroup
&EndpointGroupRegion=cn-hangzhou
&TrafficPercentage=20
&HealthCheckIntervalSeconds=3
&HealthCheckPath=/healthcheck
&HealthCheckPort=20
&HealthCheckProtocol=tcp
&ThresholdCount=3
&EndpointConfigurations=[{"Type":"Ip","EnableClientIPPreservation":false,"Weight":20,"Endpoint":"120.XX.XX.21"}]
&EndpointRequestProtocol=HTTP
&PortOverrides=[{"ListenerPort":443,"EndpointPort":80}]
&HealthCheckEnabled=true
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<UpdateEndpointGroupResponse>
<RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8 </RequestId>
</UpdateEndpointGroupResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | NoPermission.EnableHealthCheck | You do not have permission to enable health check. | The error message returned because you are unauthorized to enable the health check feature. You must apply to be added to the whitelist. |
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 reaches the upper limit. |
For a list of error codes, visit the API Error Center.