Global Accelerator:ListEndpointGroups - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries endpoint groups.

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:ListEndpointGroups

list

*EndpointGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Only cn-hangzhou is supported.	cn-hangzhou
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries to return per page in a paging query. Maximum value: 50. Default value: 10.	10
AcceleratorId	string	Yes	The instance ID of the Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
ListenerId	string	No	The instance ID of the listener.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupType	string	No	The type of the endpoint group. Valid values: default: default endpoint group. virtual: virtual endpoint group. Empty value: all default and virtual endpoint groups. Valid values: default : Default endpoint group. virtual : Virtual endpoint group.	virtual
AccessLogSwitch	string	No	Specifies whether to enable access logging. Valid values: on: enables access logging. off (default): disables access logging.	on
EndpointGroupId	string	No	The ID of the endpoint group.	epg-bp16jdc00bhe97sr5****
Tag	array<object>	No	The tags of the endpoint group.
	object	No	The tags of the endpoint group.
Key	string	No	The tag key of the endpoint group. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag keys.	test-key
Value	string	No	The tag value of the endpoint group. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag values.	test-value
EndpointGroupRegion	string	No	The region ID of the endpoint group used for filtering.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response information list.
TotalCount	integer	The total number of entries.	1
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The request ID.	A052D49E-CCC2-41DB-816C-DC3381503194
PageNumber	integer	The page number.	1
EndpointGroups	array<object>	The endpoint group configuration information.
	array<object>	The endpoint group configuration information.
EndpointGroupId	string	The ID of the endpoint group.	epg-bp16jdc00bhe97sr5****
EndpointGroupIpList	array	The list of outbound public IP addresses for the endpoint group. Important For endpoint groups that use private network back-to-origin routing, the console displays only the private back-to-origin addresses and no longer displays public addresses. If the network connectivity type of the backend service in the endpoint group changes (for example, from a private network to a public network, or to a hybrid public and private network back-to-origin routing), pay close attention to the changes in back-to-origin addresses and update the ACL list of the backend service in synchronization.
	string	The outbound public IP address of the endpoint group.	47.1.XX.XX
EndpointGroupUnconfirmedIpList	array	The list of new endpoint group IP addresses that are pending confirmation after the Alibaba Cloud Global Accelerator (GA) instance is upgraded.
	string	The list of new endpoint group IP addresses that are pending confirmation after the Alibaba Cloud Global Accelerator (GA) instance is upgraded.	47.1.XX.XX
State	string	The status of the endpoint group. init: Initializing. active: Normal. updating: Updating. deleteing: Deleting.	active
HealthCheckPath	string	The health check path.	/healthcheck
EndpointGroupRegion	string	The ID of the region to which the endpoint group belongs.	cn-hangzhou
HealthCheckIntervalSeconds	integer	The interval between health checks. Unit: seconds.	3
TrafficPercentage	integer	The traffic percentage routed to the endpoint group when a listener is associated with multiple endpoint groups.	100
HealthCheckProtocol	string	The health check protocol. tcp or TCP: TCP. http or HTTP: HTTP. https or HTTPS: HTTPS.	tcp
ThresholdCount	integer	The number of consecutive failed health checks before an endpoint is declared unhealthy.	3
ListenerId	string	The listener instance ID.	lsr-bp1bpn0kn908w4nbw****
AcceleratorId	string	The Alibaba Cloud Global Accelerator (GA) instance ID.	ga-bp1odcab8tmno0hdq****
EndpointConfigurations	array<object>	The endpoint configuration information.
	object	The endpoint configuration information.
Type	string	The endpoint type. Domain: Custom domain name. Ip: Custom IP address. IpTarget: Custom private IP address. PublicIp: Alibaba Cloud public IP address. ECS: ECS instance. SLB: SLB instance. ALB: ALB instance. OSS: OSS instance. ENI: Alibaba Cloud elastic network interface (ENI). NLB: NLB instance.	Ip
EnableClientIPPreservation	boolean	Specifies whether the client IP address preservation feature is enabled by using the automatic retrieval method. true: The client IP address preservation feature is enabled. false: The client IP address preservation feature is disabled.	false
Weight	integer	The weight of the endpoint.	20
ProbeProtocol	string	The probing protocol for latency monitoring. icmp: ICMP. tcp: TCP.	tcp
Endpoint	string	The IP address, domain name, or instance ID of the endpoint.	47.1.XX.XX
EnableProxyProtocol	boolean	Specifies whether the client IP address preservation feature is enabled by using the Proxy Protocol. true: The client IP address preservation feature is enabled by using the Proxy Protocol. false: The client IP address preservation feature is not enabled by using the Proxy Protocol.
ProbePort	integer	The probing port for latency monitoring.	80
EndpointId	string	The endpoint ID.	ep-bp1d2utp8qqe2a44t****
SubAddress	string	The private IP address of the elastic network interface (ENI).	172.168.XX.XX
VpcId	string	The VPC ID.	vpc-8vbhucmd5b2q2fpqqu****
VSwitchIds	array	The list of vSwitches in the VPC.
	string	The vSwitch ID.	vsw-hp3xwc2aebg2u30ln****
Provider	string	The provider information.	BAILIAN
ApiKeys	array	The API keys in the endpoint configuration.
	string	The first API key in the endpoint group.	sk-*******
PortOverrides	array<object>	The port mappings.
	object	The port mappings.
ListenerPort	integer	The listener port.	443
EndpointPort	integer	The endpoint port.	80
ForwardingRuleIds	array	The IDs of the forwarding rules associated with the endpoint group.
	string	The IDs of the forwarding rules associated with the endpoint group.	frule-bp19a3t3yzr21q3****
EndpointGroupType	string	The endpoint group type. default: Default endpoint group. virtual: Virtual endpoint group.	default
EndpointRequestProtocol	string	The backend service protocol. HTTP: HTTP. HTTPS: HTTPS.	HTTP
EndpointProtocolVersion	string	The backend service protocol version. HTTP1.1: HTTP1.1. HTTP2: HTTP2.	HTTP1.1
Description	string	The description of the endpoint group.	group1
Name	string	The name of the endpoint group.	group1
HealthCheckPort	integer	The health check port.	10
HealthCheckEnabled	boolean	Specifies whether health checks are enabled. true: Health checks are enabled. false: Health checks are disabled.	true
ServiceId	string	The ID of the service provider to which the managed instance belongs. Note This parameter is valid only when the ServiceManaged parameter is set to true.	ALB
ServiceManaged	boolean	Specifies whether the instance is a managed instance. Valid values: true: The instance is a managed instance. false: The instance is not a managed instance.	true
ServiceManagedInfos	array<object>	The list of action policies that users can execute on this managed instance. Note This parameter is valid only when the ServiceManaged parameter is set to true. When an instance is in the managed state, user operations on the instance are restricted, and certain operations are prohibited.
	object	The action policy that a user can execute on the managed instance.
Action	string	The name of the managed policy action. Create: Create an instance. Update: Update the current instance. Delete: Delete the current instance. Associate: Reference or be referenced by the current instance. UserUnmanaged: Unmanage the instance. CreateChild: Create a child resource under the current instance.	Update
ChildType	string	The child resource type. Listener: Listener resource. IpSet: Acceleration region resource. EndpointGroup: Endpoint group resource. ForwardingRule: Forwarding rule resource. Endpoint: Endpoint resource. EndpointGroupDestination: The endpoint group protocol mapping resource under a custom routing listener. EndpointPolicy: The endpoint access policy resource under a custom routing listener. Note This parameter is valid only when the Action parameter is set to CreateChild.	Listener
IsManaged	boolean	Specifies whether the managed policy action is managed. Valid values: true: The managed policy action is managed. Users do not have the permissions to perform the operation specified by Action on the managed instance. false: The managed policy action is not managed. Users can perform the operation specified by Action on the managed instance.	false
Tags	array<object>	The tags of the endpoint group.
	object	The tags of the endpoint group.
Key	string	The tag key of the endpoint group.	test-key
Value	string	The tag value of the endpoint group.	test-value
HealthCheckHost	string	The health check domain name.	www.taobao.com
EndpointIpVersion	string	The backend IP address protocol. Valid values: IPv4: (default) GA uses only IPv4 addresses to communicate with the endpoint service. IPv6: GA uses only IPv6 addresses to communicate with the endpoint service. ProtocolAffinity: The IP protocol used by GA to communicate with the endpoint service is the same as the IP protocol used by the client request.	IPv4
EndpointPrivateIpList	array<object>	The list of private IP addresses of the backend nodes.
	object
PrivateIp	string	The private IP address.	172.19.115.37
VSwitchId	string	The vSwitch ID in the VPC.	gsw-0jl6tmriqep1ga***
CIDR	string	The CIDR block associated with the private IP address.	10.0.0.0/24
HealthCheckSuccessCodes	string	The set of status codes that indicate a successful health check.	http_2xx,http_3xx
HealthCheckMethod	string	The HTTP request method used for health checks.	GET
ProxyTunnel	object	The proxy tunnel configuration.
ConnectAuthPrefix	string	The proxy tunnel connection authentication prefix.	prefix-auth
ConnectAuthSuffix	string	The proxy tunnel connection authentication suffix.	suffix-auth
ConnectSessionHashHdr	string	The name of the request header used for session hashing.	X-Session-Hash
ConnectTunnelTimeout	integer	The proxy tunnel connection timeout period. Unit: milliseconds.	5000
TunnelServerPort	integer	The tunnel server port.	8443
TunnelServerType	string	The tunnel server address type. Valid values: ip (IPv4 address) and domain (domain name).	domain
TunnelServer	string	The IPv4 address or domain name of the tunnel server.	tunnel.example.com

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "A052D49E-CCC2-41DB-816C-DC3381503194\t",
  "PageNumber": 1,
  "EndpointGroups": [
    {
      "EndpointGroupId": "epg-bp16jdc00bhe97sr5****",
      "EndpointGroupIpList": [
        "47.1.XX.XX"
      ],
      "EndpointGroupUnconfirmedIpList": [
        "47.1.XX.XX"
      ],
      "State": "active",
      "HealthCheckPath": "/healthcheck",
      "EndpointGroupRegion": "cn-hangzhou",
      "HealthCheckIntervalSeconds": 3,
      "TrafficPercentage": 100,
      "HealthCheckProtocol": "tcp",
      "ThresholdCount": 3,
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "EndpointConfigurations": [
        {
          "Type": "Ip",
          "EnableClientIPPreservation": false,
          "Weight": 20,
          "ProbeProtocol": "tcp",
          "Endpoint": "47.1.XX.XX",
          "EnableProxyProtocol": false,
          "ProbePort": 80,
          "EndpointId": "ep-bp1d2utp8qqe2a44t****",
          "SubAddress": "172.168.XX.XX",
          "VpcId": "vpc-8vbhucmd5b2q2fpqqu****",
          "VSwitchIds": [
            "vsw-hp3xwc2aebg2u30ln****"
          ],
          "Provider": "BAILIAN",
          "ApiKeys": [
            "sk-*******"
          ]
        }
      ],
      "PortOverrides": [
        {
          "ListenerPort": 443,
          "EndpointPort": 80
        }
      ],
      "ForwardingRuleIds": [
        "frule-bp19a3t3yzr21q3****"
      ],
      "EndpointGroupType": "default",
      "EndpointRequestProtocol": "HTTP",
      "EndpointProtocolVersion": "HTTP1.1",
      "Description": "group1",
      "Name": "group1",
      "HealthCheckPort": 10,
      "HealthCheckEnabled": true,
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ],
      "Tags": [
        {
          "Key": "test-key",
          "Value": "test-value"
        }
      ],
      "HealthCheckHost": "www.taobao.com",
      "EndpointIpVersion": "IPv4",
      "EndpointPrivateIpList": [
        {
          "PrivateIp": "172.19.115.37",
          "VSwitchId": "gsw-0jl6tmriqep1ga***",
          "CIDR": "10.0.0.0/24"
        }
      ],
      "HealthCheckSuccessCodes": "http_2xx,http_3xx",
      "HealthCheckMethod": "GET",
      "ProxyTunnel": {
        "ConnectAuthPrefix": "prefix-auth",
        "ConnectAuthSuffix": "suffix-auth",
        "ConnectSessionHashHdr": "X-Session-Hash",
        "ConnectTunnelTimeout": 5000,
        "TunnelServerPort": 8443,
        "TunnelServerType": "domain",
        "TunnelServer": "tunnel.example.com"
      }
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	No permissions.	No permissions.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	An error occurred while the request was being processed. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.