Queries the information about an endpoint group.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. OpenAPI Explorer automatically calculates signature values. 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 DescribeEndpointGroup

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

RegionId String Yes cn-hangzhou

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

EndpointGroupId String Yes epg-bp14sz7ftcwwjgrdm****

The ID of the endpoint group that you want to query.

Response parameters

Parameter Type Example Description
HealthCheckIntervalSeconds Integer 3

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

TrafficPercentage Integer 20

The weight of the endpoint group. If the listener is associated with multiple endpoint groups, this parameter indicates the weight of the current endpoint group.

EndpointGroupId String epg-bp14sz7ftcwwjgrdm****

The ID of the endpoint group.

Description String group1

The description of the endpoint group.

EndpointGroupIpList Array of String 101.XX.XX.22

The IP addresses in the endpoint group.

EndpointGroupUnconfirmedIpList Array of String 101.XX.XX.22

The IP addresses to be confirmed. After the GA instance is upgraded, the IP addresses that are added to the endpoint group need to be confirmed.

RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

The ID of the request.

HealthCheckPath String /healthcheck

The path on which health checks run.

ThresholdCount Integer 3

The threshold of consecutive failed health checks. If the number of consecutive failed health checks exceeds the specified value, the system considers the endpoint unhealthy.

Name String group1

The name of the endpoint group.

EndpointGroupRegion String cn-hangzhou

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

TotalCount Integer 10

The total number of entries returned.

State String active

The state of the endpoint group. Valid values:

  • init: The endpoint group is being initialized.
  • active: The endpoint group is running.
  • creating: The endpoint group is being created.
  • configuring: The endpoint group is being configured.
HealthCheckProtocol String tcp

The protocol that is used for health checks. Valid values:

  • tcp
  • http
  • https
HealthCheckPort Integer 20

The port that is used for health checks.

EndpointConfigurations Array of EndpointConfigurations

The configurations of endpoints in the endpoint group.

Type String Ip

The type of the endpoint. Valid values:

  • Domain: a custom domain name
  • Ip: a custom IP address
  • PublicIp: an Alibaba Cloud public IP address
  • ECS: an Alibaba Cloud Elastic Compute Service (ECS) instance
  • SLB: an Alibaba Cloud Server Load Balancer (SLB) instance
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 the network latency. Valid values:

  • tcp
  • icmp
Endpoint String 120.XX.XX.21

The IP address or domain name of the endpoint.

ProbePort Integer 80

The port that is used to monitor network latency.

PortOverrides Array of PortOverrides

The mappings between ports.

ListenerPort Integer 443

The port that is used by the listener.

EndpointPort Integer 80

The port that is used by the endpoint.

EndpointRequestProtocol String HTTP

The protocol that is used by the backend service.

  • HTTP
  • HTTPS
EndpointGroupType String default

The type of the endpoint group. Valid values:

  • default: The endpoint group is a default endpoint group.
  • virtual: The endpoint group is a virtual endpoint group.
ForwardingRuleIds Array of String frule-bp19a3t3yzr21q3****

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

AcceleratorId String ga-bp1odcab8tmno0hdq****

The ID of the GA instance.

ListenerId String lsr-bp1bpn0kn908w4nbw****

The ID of the listener that is associated with the endpoint group.

SlsRegion String cn-hangzhou

The region of the Log Service project.

SlsProjectName String pn-01

The name of the Log Service project.

SlsLogStoreName String lsn-01

The name of the Logstore.

AccessLogSwitch String on

Indicates the state of the binding relationship between the Log Service project and the endpoint group. Valid values:

  • on: The Log Service project is bound to the endpoint group.
  • off: No Log Service projects are bound to the endpoint group.
  • binding: The Log Service project is being bound to the endpoint group.
  • unbinding: The Log Service project is being unbound from the endpoint group.
EnableAccessLog Boolean on

Indicates whether the access logging feature is enabled. Valid values:

  • on: The access logging feature is enabled.
  • off: The access logging feature is disabled.
HealthCheckEnabled Boolean true

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

  • true: The health check feature is enabled. This is the default value.
  • false: The health check feature is disabled.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeEndpointGroup
&RegionId=cn-hangzhou
&EndpointGroupId=epg-bp14sz7ftcwwjgrdm****
&<Common request parameters>

Sample success responses

XML format

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

<DescribeEndpointGroupResponse>
    <HealthCheckIntervalSeconds>3</HealthCheckIntervalSeconds>
    <TrafficPercentage>20</TrafficPercentage>
    <EndpointGroupId>epg-bp14sz7ftcwwjgrdm****</EndpointGroupId>
    <Description>group1</Description>
    <EndpointGroupIpList>101.XX.XX.22</EndpointGroupIpList> 
    <EndpointGroupUnconfirmedIpList>101.XX.XX.22</EndpointGroupUnconfirmedIpList> 
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8    </RequestId>
    <HealthCheckPath>/healthcheck</HealthCheckPath>
    <ThresholdCount>3</ThresholdCount>
    <Name>group1</Name>
    <EndpointGroupRegion>cn-hangzhou</EndpointGroupRegion>
    <TotalCount>10</TotalCount>
    <State>active</State>
    <HealthCheckProtocol>tcp</HealthCheckProtocol>
    <HealthCheckPort>20</HealthCheckPort>
    <EndpointConfigurations>
        <Type>Ip</Type>
        <EnableClientIPPreservation>false</EnableClientIPPreservation>
        <Weight>20</Weight>
        <ProbeProtocol>tcp</ProbeProtocol>
        <Endpoint>120.XX.XX.21</Endpoint>
        <EnableProxyProtocol>false</EnableProxyProtocol>
        <ProbePort>80</ProbePort>
    </EndpointConfigurations>
    <PortOverrides>
        <ListenerPort>443</ListenerPort>
        <EndpointPort>80</EndpointPort>
    </PortOverrides>
    <EndpointRequestProtocol>HTTP</EndpointRequestProtocol>
    <EndpointGroupType>default</EndpointGroupType>
    <ForwardingRuleIds>frule-bp19a3t3yzr21q3****</ForwardingRuleIds>
    <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>
    <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>
    <SlsRegion>cn-hangzhou</SlsRegion>
    <SlsProjectName>pn-01</SlsProjectName>
    <SlsLogStoreName>lsn-01</SlsLogStoreName>
    <AccessLogSwitch>on</AccessLogSwitch>
    <EnableAccessLog>false</EnableAccessLog>
    <HealthCheckEnabled>false</HealthCheckEnabled>
</DescribeEndpointGroupResponse>

JSON format

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

{
  "HealthCheckIntervalSeconds" : 3,
  "TrafficPercentage" : 20,
  "EndpointGroupId" : "epg-bp14sz7ftcwwjgrdm****",
  "Description" : "group1",
  "EndpointGroupIpList" : [ "101.XX.XX.22" ], 
  "EndpointGroupUnconfirmedIpList" : [ "101.XX.XX.22" ], 
  "RequestId" : "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
  "HealthCheckPath" : "/healthcheck",
  "ThresholdCount" : 3,
  "Name" : "group1",
  "EndpointGroupRegion" : "cn-hangzhou",
  "TotalCount" : 10,
  "State" : "active",
  "HealthCheckProtocol" : "tcp",
  "HealthCheckPort" : 20,
  "EndpointConfigurations" : [ {
    "Type" : "Ip",
    "EnableClientIPPreservation" : false,
    "Weight" : 20,
    "ProbeProtocol" : "tcp",
    "Endpoint" : "120.XX.XX.21",
    "EnableProxyProtocol" : false,
    "ProbePort" : 80
  } ],
  "PortOverrides" : [ {
    "ListenerPort" : 443,
    "EndpointPort" : 80
  } ],
  "EndpointRequestProtocol" : "HTTP",
  "EndpointGroupType" : "default",
  "ForwardingRuleIds" : [ "frule-bp19a3t3yzr21q3****" ],
  "AcceleratorId" : "ga-bp1odcab8tmno0hdq****",
  "ListenerId" : "lsr-bp1bpn0kn908w4nbw****",
  "SlsRegion" : "cn-hangzhou",
  "SlsProjectName" : "pn-01",
  "SlsLogStoreName" : "lsn-01",
  "AccessLogSwitch" : "on",
  "EnableAccessLog" : false,
  "HealthCheckEnabled" : false
}

Error codes

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