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

Lists 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 ID of the region where the Global Accelerator instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10
AcceleratorId	string	Yes	The ID of the Global Accelerator instance.	ga-bp1odcab8tmno0hdq****
ListenerId	string	No	The ID of the listener.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupType	string	No	The type of the endpoint group. Valid values: default: a default endpoint group. virtual: a virtual endpoint group. If you omit this parameter, the operation returns all default and virtual endpoint groups.	virtual
AccessLogSwitch	string	No	Whether to enable the access log. Valid values: on: enables the access log. off (default): disables the access log.	on
EndpointGroupId	string	No	The ID of the endpoint group.	epg-bp16jdc00bhe97sr5****
Tag	array<object>	No	The tags used to filter endpoint groups. You can specify up to 20 tags.
	object	No	A tag.
Key	string	No	The tag key. The tag key cannot be an empty string. The tag key can be up to 64 characters long and cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	test-key
Value	string	No	The tag value. The tag value can be an empty string. The tag value can be up to 128 characters long and cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	test-value

Response elements

Element	Type	Description	Example
	object	The response data.
TotalCount	integer	The total number of entries returned.	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 list of endpoint groups.
	array<object>	The list of endpoint groups.
EndpointGroupId	string	The ID of the endpoint group.	epg-bp16jdc00bhe97sr5****
EndpointGroupIpList	array	A list of public egress IP addresses of the endpoint group. Important For endpoint groups connected to private backend services, the console shows only the private source IP addresses, not the public ones. If the network connection type of a backend service changes (for example, from private to public), monitor the source IP addresses and update the backend service's access control list (ACL).
	string	A public egress IP address of the endpoint group.	47.1.XX.XX
EndpointGroupUnconfirmedIpList	array	The list of new IP addresses in the endpoint group that require confirmation after a Global Accelerator instance is upgraded.
	string	A new IP address in the endpoint group that requires confirmation after a Global Accelerator instance is upgraded.	47.1.XX.XX
State	string	The state of the endpoint group. init: The endpoint group is initializing. active: The endpoint group is stable. updating: The endpoint group is updating. deleting: The endpoint group is deleting.	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 health check interval, in seconds.	3
TrafficPercentage	integer	The percentage of traffic routed to the endpoint group. This parameter applies only if a listener is associated with multiple endpoint groups.	100
HealthCheckProtocol	string	The protocol used for health checks. tcp or TCP: TCP http or HTTP: HTTP https or HTTPS: HTTPS	tcp
ThresholdCount	integer	The number of consecutive failed health checks required to mark an endpoint as unhealthy.	3
ListenerId	string	The ID of the listener.	lsr-bp1bpn0kn908w4nbw****
AcceleratorId	string	The ID of the Global Accelerator instance.	ga-bp1odcab8tmno0hdq****
EndpointConfigurations	array<object>	A list of endpoint configurations.
	object	An endpoint configuration.
Type	string	The type of endpoint. Valid values: Domain: a custom domain name. Ip: a custom IP address. IpTarget: a custom private IP address. 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 bucket. ENI: an Alibaba Cloud elastic network interface. NLB: an Alibaba Cloud NLB instance.	Ip
EnableClientIPPreservation	boolean	Specifies whether to preserve client IP addresses. true: Client IP preservation is enabled. false: Client IP preservation is disabled.	false
Weight	integer	The weight of the endpoint.	20
ProbeProtocol	string	The protocol that is used for latency monitoring probes. icmp: ICMP tcp: TCP	tcp
Endpoint	string	The endpoint's IP address, domain name, or instance ID.	47.1.XX.XX
EnableProxyProtocol	boolean	Specifies whether to use Proxy Protocol to preserve client IP addresses. true: Proxy Protocol is enabled. false: Proxy Protocol is disabled.
ProbePort	integer	The port used for latency monitoring probes.	80
EndpointId	string	The ID of the endpoint.	ep-bp1d2utp8qqe2a44t****
SubAddress	string	The private IP address of the elastic network interface.	172.168.XX.XX
VpcId	string	The ID of the VPC.	vpc-8vbhucmd5b2q2fpqqu****
VSwitchIds	array	A list of vSwitches in the VPC.
	string	The ID of the vSwitch.	vsw-hp3xwc2aebg2u30ln****
Provider	string	The service provider.	BAILIAN
ApiKeys	array	The API keys in the endpoint configuration.
	string	An API key of the endpoint.	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 forwarding rules associated with the endpoint group.
	string	The ID of a forwarding rule associated with the endpoint group.	frule-bp19a3t3yzr21q3****
EndpointGroupType	string	The type of the endpoint group. Valid values: default: a default endpoint group. virtual: a virtual endpoint group.	default
EndpointRequestProtocol	string	The protocol of the backend service. Valid values: HTTP: HTTP HTTPS: HTTPS	HTTP
EndpointProtocolVersion	string	The version of the backend service protocol. 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	Specifies whether to enable health checks. true: Health checks are enabled. false: Health checks are disabled.	true
ServiceId	string	The ID of the service that manages the instance. Note This parameter is returned only if ServiceManaged is true.	ALB
ServiceManaged	boolean	Specifies whether the instance is managed. Valid values: true: The instance is a managed instance. false: The instance is not a managed instance.	true
ServiceManagedInfos	array<object>	The actions that you can perform on the managed instance. Note This parameter is returned only if ServiceManaged is true. Your permissions to operate on a managed instance are restricted.
	object	The actions that you can perform on the managed instance.
Action	string	The name of the action on the managed instance. Valid values: Create: creates an instance. Update: updates the instance. Delete: deletes the instance. Associate: associates the instance with other resources. UserUnmanaged: Reverts the instance to an unmanaged state. CreateChild: creates a child resource for the instance.	Update
ChildType	string	The type of the child resource. Valid values: Listener: a listener. IpSet: an acceleration region. EndpointGroup: an endpoint group. ForwardingRule: a forwarding rule. Endpoint: an endpoint. EndpointGroupDestination: a protocol mapping for an endpoint group of a custom routing listener. EndpointPolicy: a traffic policy for an endpoint of a custom routing listener. Note This parameter is returned only if Action is set to CreateChild.	Listener
IsManaged	boolean	Specifies whether the action is managed. Valid values: true: The action is managed. You cannot perform the specified action on the managed instance. false: The action is not managed. You can perform the specified action on the managed instance.	false
Tags	array<object>	The tags attached to the endpoint group.
	object	A tag of the endpoint group.
Key	string	The tag key.	test-key
Value	string	The tag value.	test-value
HealthCheckHost	string	The domain name used for health checks.	www.taobao.com
EndpointIpVersion	string	The IP protocol of the backend service. Valid values: IPv4 (default): Connections to the backend service use IPv4. IPv6: Connections to the backend service use IPv6. ProtocolAffinity: The connection to the backend service uses the same IP protocol as the client request.	IPv4
EndpointPrivateIpList	array<object>	A list of private IP addresses of the endpoints.
	object
PrivateIp	string	The private IP address.	172.19.115.37
VSwitchId	string	The ID of the vSwitch.	gsw-0jl6tmriqep1ga***
CIDR	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": ""
        }
      ]
    }
  ]
}

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.