All Products
Search
Document Center

Global Accelerator:UpdateEndpointGroup

Last Updated:May 16, 2024

Modifies an endpoint group of a basic Global Accelerator (GA) instance.

Operation description

  • UpdateEndpointGroup is an asynchronous operation. After you send a request, the system returns a request ID, but the operation is still being performed in the system background. You can call the DescribeEndpointGroup operation to query the state of an endpoint group.

    • If the endpoint group is in the updating state, it indicates that the configurations of the endpoint group are being modified. In this case, you can perform only query operations.
    • If the endpoint group is in the active state, it indicates that the configurations of the endpoint group are modified.
  • The UpdateEndpointGroup operation cannot be repeatedly called for the same Global Accelerator (GA) instance within a specific period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ga:UpdateEndpointGroupWrite
  • EndpointGroup
    acs:ga:{#regionId}:{#accountId}:endpointgroup/{#endpointGroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.

cn-hangzhou
ClientTokenstringNo

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 all requests. ClientToken can contain only ASCII characters.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId may be different for each API request.
123e4567-e89b-12d3-a456-426655440000
EndpointGroupIdstringYes

The ID of the endpoint group.

epg-bp1dmlohjjz4kqaun****
NamestringNo

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.

group1
DescriptionstringNo

The description of the endpoint group.

The description cannot exceed 256 characters in length and cannot contain http:// or https://.

EndpointGroup
EndpointGroupRegionstringYes

The ID of the region where the endpoint group is created.

cn-hangzhou
TrafficPercentageintegerNo

The weight of the endpoint group when the listener is associated with multiple endpoint groups.

20
HealthCheckIntervalSecondsintegerNo

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

3
HealthCheckPathstringNo

The path to which health check requests are sent.

/healthcheck
HealthCheckPortintegerNo

The port that is used for health checks. Valid values: 1 to 65535.

20
HealthCheckProtocolstringNo

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

  • tcp: TCP
  • http: HTTP
  • https: HTTPS
tcp
ThresholdCountintegerNo

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

Valid values: 2 to 10.

3
EndpointConfigurationsobject []Yes

The information about the endpoints.

You can specify information for up to 20 endpoints.

TypestringYes

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: Elastic Compute Service (ECS) instance.
  • SLB: Server Load Balancer (SLB) instance.
  • ALB: Application Load Balancer (ALB) instance.
  • OSS: Object Storage Service (OSS) bucket.
  • ENI: Elastic Network interface (ENI).
  • NLB: Network Load Balancer (NLB) instance.
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.

    Ip
    EnableClientIPPreservationbooleanNo

    Specifies whether to reserve client IP addresses. Default value: false. Valid values:

    • true: reserves client IP addresses.
    • false: does not reserve client IP addresses.
    false
    WeightintegerYes

    The weight of the endpoint.

    Valid values: 0 to 255.

    Note If the weight of an endpoint is set to 0, GA stops distributing network traffic to the endpoint. Proceed with caution.
    20
    EnableProxyProtocolbooleanNo

    Specifies whether to preserve client IP addresses by using the ProxyProtocol module. Default value: false. Valid values:

    • true: preserves client IP addresses by using the ProxyProtocol module.
    • false: does not preserve client IP addresses by using the ProxyProtocol module.
    false
    EndpointstringYes

    The IP address or domain name of the endpoint.

    120.XX.XX.21
    SubAddressstringNo

    The private IP address of the ENI.

    Note
  • When the Endpoint type is ENI, this parameter can be configured. If not configured, it defaults to the primary private IP address of ENI.
  • 172.168.XX.XX
    EndpointRequestProtocolstringNo

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

    • HTTP
    • HTTPS
    Note
  • You can set this parameter only when the listener that is associated with the endpoint group uses the HTTP or HTTPS protocol.
  • For an HTTP listener, the backend service protocol must be HTTP.
  • HTTP
    PortOverridesobject []No

    The mappings between ports.

    ListenerPortintegerNo

    The listener port that is mapped to the endpoint port.

    Note
  • Only HTTP and HTTPS listeners support port mappings.
  • The listener port in a port mapping must be the one used by the current listener.
  • 443
    EndpointPortintegerNo

    The endpoint port that is mapped to the listener port.

    80
    HealthCheckEnabledbooleanNo

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

    • true: enables the health check feature.
    • false: disables the health check feature.
    true

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    6FEA0CF3-D3B9-43E5-A304-D217037876A8

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400NoPermission.EnableHealthCheckYou do not have permission to enable health check.The current account does not have the permissions to enable health checks.
    400NotExist.EndPointGroupThe endpoint group does not exist.The endpoint group does not exist.
    400StateError.EndPointGroupThe specified state of endpoint group is invalid.The endpoint group is in an invalid state.
    400NotExist.ListenerThe listener does not exist.The listener does not exist.
    400NotActive.ListenerThe state of the listener is not active.The listener is unstable.
    400NotExist.AcceleratorThe accelerated instance does not exist.The GA instance does not exist.
    400StateError.AcceleratorThe state of the accelerated instance is invalid.The status of the GA instance is invalid.
    400QuotaExceeded.EndPointThe maximum number of endpoints is exceeded.The maximum number of endpoints is exceeded.
    400NoPermission.VpcEndpointYou 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.
    400EndPointRequestProtocolIllegal.EndpointGroupendpoint group request protoco is illegal-
    400QuotaExceeded.PortOverrideThe number of port override exceeds the limit.The number of port override exceeds the limit.
    400NotExist.ListenerPortlistener port %s is not exist-

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-11-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2023-09-14The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2023-06-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400