All Products
Search
Document Center

Global Accelerator:ListEndpointGroups

Last Updated:Sep 09, 2024

Queries a list of endpoint groups.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.

cn-hangzhou
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 50. Default value: 10.

10
AcceleratorIdstringYes

The ID of the GA instance.

ga-bp1odcab8tmno0hdq****
ListenerIdstringNo

The ID of the listener.

lsr-bp1bpn0kn908w4nbw****
EndpointGroupTypestringNo

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
AccessLogSwitchstringNo

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
EndpointGroupIdstringNo

The ID of the endpoint group.

epg-bp16jdc00bhe97sr5****
Tagarray<object>No

The tag of the endpoint group.

objectNo

The name of the endpoint group.

KeystringNo

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
ValuestringNo

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

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountinteger

The total number of entries returned.

1
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

A052D49E-CCC2-41DB-816C-DC3381503194
PageNumberinteger

The page number of the returned page.

1
EndpointGroupsarray<object>

The configurations of the endpoint group.

object

The configurations of the endpoint group.

EndpointGroupIdstring

The ID of the endpoint group.

epg-bp16jdc00bhe97sr5****
EndpointGroupIpListarray

The endpoint group IP addresses.

string

The endpoint group IP address.

47.1.XX.XX
EndpointGroupUnconfirmedIpListarray

The endpoint group IP addresses to be confirmed after the GA instance is upgraded.

string

The endpoint group IP address to be confirmed after the GA instance is upgraded.

47.1.XX.XX
Statestring

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
HealthCheckPathstring

The path that is used for health checks.

/healthcheck
EndpointGroupRegionstring

The ID of the region where the endpoint group is created.

cn-hangzhou
HealthCheckIntervalSecondsinteger

The interval at which you want to perform health checks. Unit: seconds.

3
TrafficPercentageinteger

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
HealthCheckProtocolstring

The protocol over which health check requests are sent. Valid values:

  • tcp or TCP
  • http or HTTP
  • https or HTTPS
tcp
ThresholdCountinteger

The number of consecutive failed health checks that must occur before an endpoint is considered unhealthy.

3
ListenerIdstring

The ID of the listener.

lsr-bp1bpn0kn908w4nbw****
AcceleratorIdstring

The ID of the GA instance.

ga-bp1odcab8tmno0hdq****
EndpointConfigurationsarray<object>

The configurations of endpoints in the endpoint group.

object

The configurations of the endpoint.

Typestring

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
EnableClientIPPreservationboolean

Indicates whether the client IP address preservation feature is enabled. Valid values:

  • true
  • false
false
Weightinteger

The weight of the endpoint.

20
ProbeProtocolstring

The protocol that is used to monitor latency.

  • icmp
  • tcp
tcp
Endpointstring

The IP address or domain name of the endpoint.

47.1.XX.XX
ProbePortinteger

The port that is used to monitor latency.

80
EndpointIdstring

The ID of the endpoint.

ep-bp1d2utp8qqe2a44t****
SubAddressstring

The private IP address of the ENI.

172.168.XX.XX
PortOverridesarray<object>

The port mapping.

object

The mappings between ports.

ListenerPortinteger

The listener port.

443
EndpointPortinteger

The endpoint port.

80
ForwardingRuleIdsarray

The IDs of the forwarding rules that are associated with the endpoint group.

string

The ID of the forwarding rule that is associated with the endpoint group.

frule-bp19a3t3yzr21q3****
EndpointGroupTypestring

The type of the endpoint group. Valid values:

  • default: a default endpoint group
  • virtual: a virtual endpoint group.
default
EndpointRequestProtocolstring

The protocol that is used by the backend server.

  • HTTP
  • HTTPS
HTTP
Descriptionstring

The description of the endpoint group.

group1
Namestring

The name of the endpoint group.

group1
HealthCheckPortinteger

The port that is used for health checks.

10
HealthCheckEnabledboolean

Indicates whether the health check feature is enabled.

  • true
  • false
true
ServiceIdstring

The service that manages the instance.

Note This parameter takes effect only if the value of Service managed is true.
ALB
ServiceManagedboolean

Indicates whether the GA instance is managed. Valid values:

  • true
  • false
true
ServiceManagedInfosarray<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.

object

A list of action policies that users can execute on this managed instance.

Actionstring

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
ChildTypestring

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
IsManagedboolean

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
Tagsarray<object>

The tag of the endpoint group.

object

The tags of the endpoint groups.

Keystring

The tag key of the endpoint group.

test-key
Valuestring

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 codeError codeError messageDescription
400NoPermissionNo permissions.No permissions.
500UnknownErrorAn 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 timeSummary of changesOperation
2024-07-20The Error code has changed. The response structure of the API has changedView Change Details
2023-09-14The Error code has changed. The response structure of the API has changedView Change Details
2023-08-15The Error code has changed. The response structure of the API has changedView Change Details
2023-07-20The Error code has changedView Change Details
2023-04-27The Error code has changedView Change Details
2021-04-27The request parameters of the API has changed. The response structure of the API has changedView Change Details