All Products
Search

This Product

    Global Accelerator:UpdateEndpointGroups

    Document Center

    Global Accelerator:UpdateEndpointGroups

    Last Updated:Apr 10, 2024

    Modifies the endpoint groups that are associated with a listener.

    Operation description

    Description

    • UpdateEndpointGroups is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the DescribeEndpointGroup or ListEndpointGroups operation to query the status of an endpoint group.

      • If the endpoint group is in the updating state, it indicates that the configuration of the endpoint group is being modified. In this case, you can perform only query operations.
      • If the endpoint group is in the active state, it indicates that the configuration of the endpoint group is modified.

    • The UpdateEndpointGroups operation holds an exclusive lock on the Global Accelerator (GA) instance. While the operation is in progress, you cannot call the same operation in the same Alibaba Cloud account.

    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:UpdateEndpointGroupsWrite
    • EndpointGroup
      acs:ga:{#regionId}:{#accountId}:endpointgroup/{#endpointgroupId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the GA instance. 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 token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		123e4567-e89b-12d3-a456-426655440000
    DryRunbooleanNo

    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    		true
    EndpointGroupConfigurationsobject []Yes

    The configurations of the endpoint group.

    EndpointGroupNamestringNo

    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
    EndpointGroupDescriptionstringNo

    The description of the endpoint group.

    The description can be up to 256 characters in length and cannot contain http:// or https://.

    		group1
    TrafficPercentagelongNo

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

    Valid values: 1 to 100.

    		20
    HealthCheckEnabledbooleanNo

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

    • true
    • false (default)
    		true
    HealthCheckIntervalSecondslongNo

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

    		3
    HealthCheckPathstringNo

    The health check path.

    		/healthcheck
    HealthCheckPortlongNo

    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 or TCP
    • http or HTTP
    • https or HTTPS
    		tcp
    ThresholdCountlongNo

    The number of failed consecutive health checks that must occur before a healthy endpoint group is considered unhealthy or the number of successful consecutive health checks that must occur before an unhealthy endpoint group is considered healthy.

    Valid values: 2 to 10.

    		3
    EndpointConfigurationsobject []No

    The configurations of endpoints in the endpoint group.

    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: 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.
    • ENI: an elastic network interface (ENI).
    • NLB: a Network Load Balancer (NLB) instance.
    Note
  • If you set this parameter to ECS or SLB and the AliyunServiceRoleForGaVpcEndpoint service-linked role does not exist, the system automatically creates the role.
  • If you set this parameter to ALB and the AliyunServiceRoleForGaAlb service-linked role does not exist, the system automatically creates the role.
  • If you set this parameter to OSS and the AliyunServiceRoleForGaOss service-linked role does not exist, the system automatically creates the role.
    •

    For more information, see Service-linked roles.
    		Ip
    WeightlongYes

    The weight of the endpoint.

    Valid values: 0 to 255.

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

    The IP address, domain name, or instance ID based on the value of Type.

    		47.0.XX.XX
    SubAddressstringNo

    The private IP address of the ENI.

    Note If you set the endpoint type to ENI, you can specify this parameter. If you leave this parameter empty, the primary private IP address of the ENI is used.
    		172.168.XX.XX
    EndpointRequestProtocolstringNo

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

    • HTTP
    • HTTPS
    Note
  • You can specify this parameter only if the listener that is associated with the endpoint group uses HTTP or HTTPS.
  • The backend service protocol of an HTTP listener must be HTTP.
    •
    		HTTP
    PortOverridesobject []No

    The port mapping.

    ListenerPortlongNo

    The listener port.

    Valid values: 1 to 65499.

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

    The endpoint port.

    Valid values: 1 to 65499.

    		80
    EnableClientIPPreservationToabooleanNo

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

    • true
    • false
    		false
    EnableClientIPPreservationProxyProtocolbooleanNo

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

    • true
    • false
    		false
    EndpointGroupIdstringYes

    The ID of the endpoint.

    		ep-bp1d2utp8qqe2a44t****
    ListenerIdstringYes

    The listener ID.

    		lsr-bp1bpn0kn908w4nbw****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		6FEA0CF3-D3B9-43E5-A304-D217037876A8
    EndpointGroupIdsarray

    The IDs of the endpoint groups.

    string

    The endpoint group ID.

    		['epg-bp1dmlohjjz4kqaun****','epg-bp1v1u72cx35ogofe****', ...]

    Examples

    Sample success responses

    JSONformat

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

    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