ListEndpointGroups - Global Accelerator

Queries a list of endpoint groups.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ga:ListEndpointGroups	list	EndpointGroup acs:ga:{#regionId}:{#accountId}:endpointgroup/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator (GA) 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 per page. Maximum value: 50. Default value: 10.	10
AcceleratorId	string	Yes	The ID of the GA 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 virtual If you leave this parameter empty, all default and virtual endpoint groups are queried.	virtual
AccessLogSwitch	string	No	Specifies whether the access logging feature is enabled. Default value: off. Valid values: on: The access logging feature is enabled. off: The access logging feature is disabled.	on
EndpointGroupId	string	No	The ID of the endpoint group.	epg-bp16jdc00bhe97sr5****
Tag	array<object>	No	The tag of the endpoint group.
	object	No	The name of the endpoint group.
Key	string	No	The tag key of the endpoint group. It cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`. 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 contain `http://` or `https://`. The tag value cannot start with `aliyun` or `acs:`. You can specify up to 20 tag values.	test-value

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	A052D49E-CCC2-41DB-816C-DC3381503194
PageNumber	integer	The page number of the returned page.	1
EndpointGroups	array<object>	The configurations of the endpoint group.
EndpointGroups	object	The configurations of the endpoint group.
EndpointGroupId	string	The ID of the endpoint group.	epg-bp16jdc00bhe97sr5****
EndpointGroupIpList	array	The endpoint group IP addresses.
EndpointGroupIpList	string	The endpoint group IP address.	47.1.XX.XX
EndpointGroupUnconfirmedIpList	array	The endpoint group IP addresses to be confirmed after the GA instance is upgraded.
endpointGroupUnconfirmedIpList	string	The endpoint group IP address to be confirmed after the 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 normally. updating:The endpoint group is being updated. deleteing: The endpoint group is being deleted.	active
HealthCheckPath	string	The path that is used for health checks.	/healthcheck
EndpointGroupRegion	string	The ID of the region where the endpoint group is created.	cn-hangzhou
HealthCheckIntervalSeconds	integer	The interval at which you want to perform health checks. Unit: seconds.	3
TrafficPercentage	integer	The value of the traffic distribution ratio. If a listener is associated with multiple endpoint groups, you can set this parameter to distribute different percentages of traffic to the endpoint groups.	20
HealthCheckProtocol	string	The protocol over which health check requests are sent. Valid values: tcp or TCP http or HTTP https or HTTPS	tcp
ThresholdCount	integer	The number of consecutive failed health checks that must occur before an endpoint is considered unhealthy.	3
ListenerId	string	The ID of the listener.	lsr-bp1bpn0kn908w4nbw****
AcceleratorId	string	The ID of the GA instance.	ga-bp1odcab8tmno0hdq****
EndpointConfigurations	array<object>	The configurations of endpoints in the endpoint group.
EndpointConfigurations	object	The configurations of the endpoint.
Type	string	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 Classic 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.	Ip
EnableClientIPPreservation	boolean	Indicates whether the client IP address preservation feature is enabled. Valid values: true false	false
Weight	integer	The weight of the endpoint.	20
ProbeProtocol	string	The protocol that is used to monitor latency. icmp tcp	tcp
Endpoint	string	The IP address or domain name of the endpoint.	47.1.XX.XX
ProbePort	integer	The port that is used to monitor latency.	80
EndpointId	string	The ID of the endpoint.	ep-bp1d2utp8qqe2a44t****
SubAddress	string	The private IP address of the ENI.	172.168.XX.XX
PortOverrides	array<object>	The port mapping.
PortOverrides	object	The mappings between ports.
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.
ForwardingRuleIds	string	The ID of the forwarding rule that is 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 that is used by the backend server. HTTP HTTPS	HTTP
EndpointProtocolVersion	string	The protocol version that is used by the backend service. Valid values: HTTP1.1 HTTP2
Description	string	The description of the endpoint group.	group1
Name	string	The name of the endpoint group.	group1
HealthCheckPort	integer	The port that is used for health checks.	10
HealthCheckEnabled	boolean	Indicates whether the health check feature is enabled. true false	true
ServiceId	string	The service that manages the instance. Note This parameter takes effect only if the value of Service managed is true.	ALB
ServiceManaged	boolean	Indicates whether the GA instance is managed. Valid values: true false	true
ServiceManagedInfos	array<object>	The actions that users can perform on the managed instance. Note This parameter takes effect only if the value of ServiceManaged is true. Users can perform only specific actions on a managed instance.
ServiceManagedInfos	object	A list of action policies that users can execute on this managed instance.
Action	string	The name of the action that was performed on the managed instance. Valid values: Create: Create an instance. Update: Update the current instance. Delete: Delete the current instance. Associate: Reference the current instance. UserUnmanaged: Unmanage the instance. CreateChild: Create a child resource in the current instance.	Update
ChildType	string	The type of the child resource. Valid values: Listener: listener. IpSet: acceleration region. EndpointGroup: endpoint group. ForwardingRule: forwarding rule. Endpoint: endpoint. EndpointGroupDestination: the protocol mapping of an endpoint group associated with a custom routing listener. EndpointPolicy: the traffic policy of an endpoint associated with a custom routing listener. Note This parameter takes effect only if you set Action to CreateChild.	Listener
IsManaged	boolean	Indicates whether the specified actions are managed. Valid values: true: The specified actions are managed, and users cannot perform the specified actions on the managed instance. false: The specified actions are not managed, and users can perform the specified actions on the managed instance.	false
Tags	array<object>	The tag of the endpoint group.
Tags	object	The tags of the endpoint groups.
Key	string	The tag key of the endpoint group.	test-key
Value	string	The tag value of the endpoint group.	test-value

Examples

Sample success responses

JSONformat

{
  "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": 20,
      "HealthCheckProtocol": "tcp",
      "ThresholdCount": 3,
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "EndpointConfigurations": [
        {
          "Type": "Ip",
          "EnableClientIPPreservation": false,
          "Weight": 20,
          "ProbeProtocol": "tcp",
          "Endpoint": "47.1.XX.XX",
          "ProbePort": 80,
          "EndpointId": "ep-bp1d2utp8qqe2a44t****",
          "SubAddress": "172.168.XX.XX"
        }
      ],
      "PortOverrides": [
        {
          "ListenerPort": 443,
          "EndpointPort": 80
        }
      ],
      "ForwardingRuleIds": [
        "frule-bp19a3t3yzr21q3****"
      ],
      "EndpointGroupType": "default",
      "EndpointRequestProtocol": "HTTP",
      "EndpointProtocolVersion": "",
      "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"
        }
      ]
    }
  ]
}

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.

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

Change history

Change time	Summary of changes	Operation
2024-07-20	The Error code has changed. The response structure of the API has changed	View Change Details
2023-09-14	The Error code has changed. The response structure of the API has changed	View Change Details
2023-08-15	The Error code has changed. The response structure of the API has changed	View Change Details
2023-07-20	The Error code has changed	View Change Details
2023-04-27	The Error code has changed	View Change Details
2021-04-27	The request parameters of the API has changed. The response structure of the API has changed	View Change Details