Queris the 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListEndpointGroups

The operation that you want to perform. Set the value to ListEndpointGroups.

RegionId String Yes cn-hangzhou

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

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 50. Default value: 10.

AcceleratorId String Yes ga-bp1odcab8tmno0hdq****

The ID of the GA instance that you want to query.

ListenerId String No lsr-bp1bpn0kn908w4nbw****

The ID of the listener.

EndpointGroupType String No virtual

The type of the endpoint group. Valid values:

  • default: a default endpoint group
  • virtual: a virtual endpoint group
  • If you leave this parameter empty, all default and virtual endpoint groups are queried.
AccessLogSwitch String No on

Specifies whether to enable the access logging feature. Valid values:

  • on: enables the access logging feature.
  • off: disables the access logging feature. This is the default value.
EndpointGroupId String No epg-bp16jdc00bhe97sr5****

The ID of the endpoint group.

Response parameters

Parameter Type Example Description
TotalCount Integer 10

The total number of entries returned.

PageSize Integer 10

The number of entries returned per page.

RequestId String A052D49E-CCC2-41DB-816C-DC3381503194

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

EndpointGroups Array of EndpointGroups

The configurations of the endpoint group.

EndpointGroupId String epg-bp16jdc00bhe97sr5****

The ID of the endpoint group.

EndpointGroupIpList Array of String 47.1.XX.XX

The list of endpoint group IP addresses.

EndpointGroupUnconfirmedIpList Array of String 47.1.XX.XX

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

State String active

The status of the endpoint group. Valid values:

  • init: The endpoint group is being initialized.
  • active: The endpoint group is running as expected.
  • creating: The endpoint group is being created.
  • configuring: The endpoint group is being configured.
HealthCheckPath String /healthcheck

The path to which health check requests are sent.

EndpointGroupRegion String cn-hangzhou

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

HealthCheckIntervalSeconds Integer 3

The interval at which health checks are performed. Unit: seconds.

TrafficPercentage Integer 20

The weight of the endpoint group when the listener is associated with multiple endpoint groups.

HealthCheckProtocol String tcp

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

  • tcp: TCP
  • http: HTTP
  • https: HTTPS
ThresholdCount Integer 3

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

ListenerId String lsr-bp1bpn0kn908w4nbw****

The ID of the listener.

AcceleratorId String ga-bp1odcab8tmno0hdq****

The ID of the GA instance.

EndpointConfigurations Array of EndpointConfigurations

The configurations of the endpoint.

Type String Ip

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 Server Load Balancer (SLB) instance
  • ALB: an Application Load Balancer (ALB) instance
  • OSS: an Object Storage Service (OSS) bucket
EnableClientIPPreservation Boolean false

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

  • true: The client IP address preservation feature is enabled.
  • false: The client IP address preservation feature is disabled.
Weight Integer 20

The weight of the endpoint.

ProbeProtocol String tcp

The protocol that is used to monitor latency. Valid values:

  • icmp: ICMP
  • tcp: TCP
Endpoint String 47.1.XX.XX

The IP address or domain name of the endpoint.

ProbePort Integer 80

The port that is used to monitor latency.

EndpointId String ep-bp1d2utp8qqe2a44t****

The ID of the endpoint.

PortOverrides Array of PortOverrides

The mappings between ports.

ListenerPort Integer 443

The listening port.

EndpointPort Integer 80

The endpoint port.

ForwardingRuleIds Array of String frule-bp19a3t3yzr21q3****

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

EndpointGroupType String default

The type of the endpoint group. Valid values:

  • default: a default endpoint group
  • virtual: a virtual endpoint group
EndpointRequestProtocol String HTTP

The protocol that is used by the backend service. Valid values:

  • HTTP: HTTP
  • HTTPS: HTTPS
Description String group1

The description of the endpoint group.

Name String group1

The name of the endpoint group.

HealthCheckPort Integer 10

The port that is used for health checks.

HealthCheckEnabled Boolean true

Indicates whether the health check feature is enabled. Valid values:

  • true: The health check feature is enabled.
  • false: The health check feature is disabled.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListEndpointGroups
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&EndpointGroupType=virtual
&AccessLogSwitch=on
&EndpointGroupId=epg-bp16jdc00bhe97sr5****
&Common request parameter

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListEndpointGroupsResponse>
    <TotalCount>10</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>A052D49E-CCC2-41DB-816C-DC3381503194	</RequestId>
    <PageNumber>1</PageNumber>
    <EndpointGroups>
        <EndpointGroupId>epg-bp16jdc00bhe97sr5****</EndpointGroupId>
        <EndpointGroupIpList>47.1.XX.XX</EndpointGroupIpList>
        <EndpointGroupUnconfirmedIpList>47.1.XX.XX</EndpointGroupUnconfirmedIpList>
        <State>active</State>
        <HealthCheckPath>/healthcheck</HealthCheckPath>
        <EndpointGroupRegion>cn-hangzhou</EndpointGroupRegion>
        <HealthCheckIntervalSeconds>3</HealthCheckIntervalSeconds>
        <TrafficPercentage>20</TrafficPercentage>
        <HealthCheckProtocol>tcp</HealthCheckProtocol>
        <ThresholdCount>3</ThresholdCount>
        <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>
        <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>
        <EndpointConfigurations>
            <Type>Ip</Type>
            <EnableClientIPPreservation>false</EnableClientIPPreservation>
            <Weight>20</Weight>
            <ProbeProtocol>tcp</ProbeProtocol>
            <Endpoint>47.1.XX.XX</Endpoint>
            <ProbePort>80</ProbePort>
            <EndpointId>ep-bp1d2utp8qqe2a44t****</EndpointId>
        </EndpointConfigurations>
        <PortOverrides>
            <ListenerPort>443</ListenerPort>
            <EndpointPort>80</EndpointPort>
        </PortOverrides>
        <ForwardingRuleIds>frule-bp19a3t3yzr21q3****</ForwardingRuleIds>
        <EndpointGroupType>default</EndpointGroupType>
        <EndpointRequestProtocol>HTTP</EndpointRequestProtocol>
        <Description>group1</Description>
        <Name>group1</Name>
        <HealthCheckPort>10</HealthCheckPort>
        <HealthCheckEnabled>true</HealthCheckEnabled>
    </EndpointGroups>
</ListEndpointGroupsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 10,
  "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****"
    } ],
    "PortOverrides" : [ {
      "ListenerPort" : 443,
      "EndpointPort" : 80
    } ],
    "ForwardingRuleIds" : [ "frule-bp19a3t3yzr21q3****" ],
    "EndpointGroupType" : "default",
    "EndpointRequestProtocol" : "HTTP",
    "Description" : "group1",
    "Name" : "group1",
    "HealthCheckPort" : 10,
    "HealthCheckEnabled" : true
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.