DescribeEndpointGroup - Global Accelerator - Alibaba Cloud Documentation Center

Queries information about an endpoint group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeEndpointGroup	get	EndpointGroup acs:ga:{#regionId}:{#accountId}:endpointgroup/{#endpointGroupId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where your Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
EndpointGroupId	string	Yes	The ID of the endpoint group that you want to query.	epg-bp14sz7ftcwwjgrdm****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HealthCheckIntervalSeconds	integer	The interval between two consecutive health checks. Unit: seconds.	3
TrafficPercentage	integer	The traffic ratio of the endpoint group when the specified listener is associated with multiple endpoint groups.	20
EndpointGroupId	string	The ID of the endpoint group.	epg-bp14sz7ftcwwjgrdm****
Description	string	The description of the endpoint group.	group1
EndpointGroupIpList	array	The active endpoint IP addresses of the endpoint group.
	string	The active endpoint IP addresses of the endpoint group.	101.XX.XX.22
EndpointGroupUnconfirmedIpList	array	The endpoint group 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.
	string	The endpoint group IP addresses to be confirmed after the GA instance is upgraded.	101.XX.XX.22
RequestId	string	The ID of the request.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
HealthCheckPath	string	The path to which health check probes are sent.	/healthcheck
ThresholdCount	integer	The number of consecutive failed health checks that must occur before an endpoint is considered unhealthy.	3
Name	string	The name of the endpoint group.	group1
EndpointGroupRegion	string	The ID of the region where the endpoint group is deployed.	cn-hangzhou
State	string	The status of the endpoint group. Valid values: init: The endpoint group is being initialized. active: The endpoint group is running as expected. updating: The endpoint group is being updated. deleting: The endpoint group is being deleted.	active
HealthCheckProtocol	string	The protocol over which health check requests are sent. Valid values: tcp or TCP http or HTTP https or HTTPS	tcp
HealthCheckPort	integer	The port that is used for health checks.	20
EndpointConfigurations	array<object>	The configurations of endpoints in the endpoint group.
	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 Server 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. Valid values: tcp icmp	tcp
Endpoint	string	The IP address, domain name, or ID of the endpoint.	120.XX.XX.21
EnableProxyProtocol	boolean	Indicates whether the proxy protocol is used to preserve client IP addresses.	false
ProbePort	integer	The port that is used to monitor latency.	80
SubAddress	string	The private IP address of the ENI.	172.168.XX.XX
PortOverrides	array<object>	The mappings between ports.
	object	The mappings between ports.
ListenerPort	integer	The listener port.	443
EndpointPort	integer	The endpoint port.	80
EndpointRequestProtocol	string	The protocol that is used by the backend service. HTTP HTTPS	HTTP
EndpointProtocolVersion	string	The version of the protocol that is used by the backend service. HTTP1.1 HTTP2
EndpointGroupType	string	The type of endpoint group. Valid values: default: a default endpoint group virtual: a virtual endpoint group	default
ForwardingRuleIds	array	The ID of the forwarding rule that is associated with the endpoint group.
	string	The ID of the forwarding rule that is associated with the endpoint group.	frule-bp19a3t3yzr21q3****
AcceleratorId	string	The ID of the GA instance.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The ID of the listener.	lsr-bp1bpn0kn908w4nbw****
SlsRegion	string	The region of the Log Service project.	cn-hangzhou
SlsProjectName	string	The name of the Log Service project.	pn-01
SlsLogStoreName	string	The name of the Logstore.	lsn-01
AccessLogSwitch	string	Indicates the binding status between the Simple Log Service project and the endpoint group. Valid values: on: The endpoint group is bound to the Simple Log Service project. off: The endpoint group is not bound to the Simple Log Service project. binding: The endpoint group is being bound to the Simple Log Service project. unbinding: The endpoint group is being unbound from the Simple Log Service project.	on
EnableAccessLog	boolean	Indicates whether the access log feature is enabled. Valid values: true false	true
HealthCheckEnabled	boolean	Indicates whether the health check feature is enabled. Valid values: true: enabled false: disabled	true
ServiceId	string	The ID of the service that manages the GA instance. Note This parameter takes effect only if ServiceManaged is set to True.	ALB
ServiceManaged	boolean	Indicates whether the instance is managed. 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.
	object
Action	string	The name of the action on the managed instance. Create Update Delete Associate UserUnmanaged CreateChild	Update
ChildType	string	The type of the child resource. Listener: listener. IpSet: acceleration region. EndpointGroup: endpoint group. ForwardingRule: forwarding rule. Endpoint: endpoint. EndpointGroupDestination: protocol mapping of an endpoint group associated with a custom routing listener. EndpointPolicy: traffic policy of an endpoint associated with a custom routing listener. Note This parameter takes effect only if the value of Action is CreateChild.	Listener
IsManaged	boolean	Indicates whether the specified actions are managed. true: The specified actions are managed. Users cannot perform the specified actions on the managed instance.** false:** The specified actions are not managed. Users can perform the specified actions on the managed instance.	false
Tags	array<object>	The tag of the endpoint group.
	object	Tag objects.
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

{
  "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",
  "State": "active",
  "HealthCheckProtocol": "tcp",
  "HealthCheckPort": 20,
  "EndpointConfigurations": [
    {
      "Type": "Ip",
      "EnableClientIPPreservation": false,
      "Weight": 20,
      "ProbeProtocol": "tcp",
      "Endpoint": "120.XX.XX.21",
      "EnableProxyProtocol": false,
      "ProbePort": 80,
      "SubAddress": "172.168.XX.XX"
    }
  ],
  "PortOverrides": [
    {
      "ListenerPort": 443,
      "EndpointPort": 80
    }
  ],
  "EndpointRequestProtocol": "HTTP",
  "EndpointProtocolVersion": "",
  "EndpointGroupType": "default",
  "ForwardingRuleIds": [
    "frule-bp19a3t3yzr21q3****"
  ],
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "SlsRegion": "cn-hangzhou",
  "SlsProjectName": "pn-01",
  "SlsLogStoreName": "lsn-01",
  "AccessLogSwitch": "on",
  "EnableAccessLog": true,
  "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
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
2021-04-27	The Error code has changed. The response structure of the API has changed	View Change Details