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

Queries a list of 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. Set the value to cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Maximum value: 50. Default value: 10.	10
AcceleratorId	string	Yes	The instance ID of the Alibaba Cloud Global Accelerator (GA) instance.	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: queries all default endpoint groups and virtual endpoint groups.	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. If you specify this parameter, the value 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. If you specify this parameter, the 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

Response elements

Element	Type	Description	Example
	object	The returned information list.
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries per page in a paging query.	10
RequestId	string	The request ID.	A052D49E-CCC2-41DB-816C-DC3381503194
PageNumber	integer	The page number.	1
EndpointGroups	array<object>	The endpoint group configurations.
	array<object>	The endpoint group configurations.
EndpointGroupId	string	The ID of the endpoint group.	epg-bp16jdc00bhe97sr5****
EndpointGroupIpList	array	The list of public IP addresses of the endpoint group. Important For endpoint groups that use private network back-to-origin, the console displays only private network back-to-origin addresses and no longer displays public IP addresses. If the network connectivity type of the backend service changes (for example, from private network to public network, or to a hybrid of private network and public network back-to-origin), promptly check the changes in back-to-origin addresses and synchronization update the ACL of the backend service accordingly.
	string	The list of public IP addresses of the endpoint group.	47.1.XX.XX
EndpointGroupUnconfirmedIpList	array	The list of unconfirmed endpoint group IP addresses that are added after the Alibaba Cloud Global Accelerator (GA) instance is upgraded.
	string	The list of unconfirmed endpoint group IP addresses that are added after the Alibaba Cloud Global Accelerator (GA) instance is upgraded.	47.1.XX.XX
State	string	The status of the endpoint group. Valid values: init: The endpoint group is being initialized. active: The endpoint group is running as expected. updating: The endpoint group is being updated. deleteing: The endpoint group is being deleted.	active
HealthCheckPath	string	The health check path.	/healthcheck
EndpointGroupRegion	string	The ID of the region where the endpoint group is deployed.	cn-hangzhou
HealthCheckIntervalSeconds	integer	The interval between two consecutive health checks. Unit: seconds.	3
TrafficPercentage	integer	The traffic ratio for the endpoint group when the listener is associated with multiple endpoint groups.	100
HealthCheckProtocol	string	The protocol used for health checks. Valid values: tcp or TCP: TCP. http or HTTP: HTTP. https or HTTPS: HTTPS.	tcp
ThresholdCount	integer	The number of consecutive health check failures that must occur before an endpoint is considered 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 configurations.
	object	The endpoint configurations.
Type	string	The endpoint type. Valid values: Domain: a custom domain name. Ip: a custom IP address. IpTarget: a custom private IP. PublicIp: an Alibaba Cloud public IP address. ECS: an Alibaba Cloud ECS instance. SLB: an Alibaba Cloud SLB instance. ALB: an Alibaba Cloud ALB instance. OSS: an Alibaba Cloud OSS instance. ENI: an Alibaba Cloud elastic network interface (ENI). NLB: an Alibaba Cloud NLB instance.	Ip
EnableClientIPPreservation	boolean	Indicates whether client IP address preservation is enabled by using the automatic method. Valid values: true: Client IP address preservation is enabled. false: Client IP address preservation is disabled.	false
Weight	integer	The weight of the endpoint.	20
ProbeProtocol	string	The probe protocol used for latency monitoring. Valid values: icmp: ICMP. tcp: TCP.	tcp
Endpoint	string	The endpoint's IP address, domain name, or instance ID.	47.1.XX.XX
EnableProxyProtocol	boolean	Indicates whether client IP address preservation is enabled by using the ProxyProtocol method. Valid values: true: Client IP address preservation is enabled by using the ProxyProtocol method. false: Client IP address preservation is not enabled by using the ProxyProtocol method.
ProbePort	integer	The probe port used for latency monitoring.	80
EndpointId	string	The endpoint ID.	ep-bp1d2utp8qqe2a44t****
SubAddress	string	The private IP 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 endpoint configurations.
	string	The first API key in the endpoint group.	sk-*******
PortOverrides	array<object>	The port mapping information.
	object	The port mapping information.
ListenerPort	integer	The listener port.	443
EndpointPort	integer	The endpoint port.	80
ForwardingRuleIds	array	The IDs of the forwarding rules that are associated with the endpoint group.
	string	The IDs of the forwarding rules that are associated with the endpoint group.	frule-bp19a3t3yzr21q3****
EndpointGroupType	string	The endpoint group type. Valid values: default: a default endpoint group. virtual: a virtual endpoint group.	default
EndpointRequestProtocol	string	The backend service protocol. Valid values: HTTP: HTTP. HTTPS: HTTPS.	HTTP
EndpointProtocolVersion	string	The backend service protocol version. Valid values: HTTP1.1: HTTP 1.1. HTTP2: HTTP 2.	HTTP1.1
Description	string	The description of the endpoint group.	group1
Name	string	The name of the endpoint group.	group1
HealthCheckPort	integer	The port used for health checks.	10
HealthCheckEnabled	boolean	Indicates whether health checks are enabled. Valid values: true: Health checks are enabled. false: Health checks are disabled.	true
ServiceId	string	The ID of the service that manages the managed instance. Note This parameter is valid only when ServiceManaged is set to True.	ALB
ServiceManaged	boolean	Indicates whether the instance is managed. Valid values: true: The instance is managed. false: The instance is not managed.	true
ServiceManagedInfos	array<object>	The list of action policies that the user can execute on the managed instance. Note This parameter is valid only when ServiceManaged is set to True. When the instance is managed, user operations on the instance are restricted, and certain actions are prohibited.
	object	The list of action policies that the user can execute on the managed instance.
Action	string	The name of the managed policy action. Valid values: Create: creates an instance. Update: updates the current instance. Delete: deletes the current instance. Associate: references or is referenced by the current instance. UserUnmanaged: unmanages the instance. CreateChild: creates a child resource under the current instance.	Update
ChildType	string	The child resource type. Valid values: Listener: a listener resource. IpSet: an acceleration region resource. EndpointGroup: an endpoint group resource. ForwardingRule: a forwarding rule resource. Endpoint: an endpoint resource. EndpointGroupDestination: a protocol mapping resource for the endpoint group under a custom routing listener. EndpointPolicy: an endpoint traffic policy resource under a custom routing listener. Note This parameter is valid only when Action is set to CreateChild.	Listener
IsManaged	boolean	Indicates whether the managed policy action is managed. Valid values: true: The managed policy action is managed. The user cannot perform the action specified by Action on the managed instance. false: The managed policy action is not managed. The user can perform the action 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 domain name used for health checks.	www.taobao.com
EndpointIpVersion	string	The IP protocol version used by the backend service. Valid values: IPv4 (default): GA communicates with the endpoint service by using only IPv4 addresses. IPv6: GA communicates with the endpoint service by using only IPv6 addresses. 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 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
HealthCheckSuccessCodes	string
HealthCheckMethod	string
ProxyTunnel	object
ConnectAuthPrefix	string
ConnectAuthSuffix	string
ConnectSessionHashHdr	string
ConnectTunnelTimeout	integer
TunnelServerPort	integer
TunnelServerType	string
TunnelServer	string

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": ""
        }
      ],
      "HealthCheckSuccessCodes": "",
      "HealthCheckMethod": "",
      "ProxyTunnel": {
        "ConnectAuthPrefix": "",
        "ConnectAuthSuffix": "",
        "ConnectSessionHashHdr": "",
        "ConnectTunnelTimeout": 0,
        "TunnelServerPort": 0,
        "TunnelServerType": "",
        "TunnelServer": ""
      }
    }
  ]
}

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.