DescribeEndpointGroup-阿里云帮助中心

Queries the details of a specified endpoint group.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ga:DescribeEndpointGroup

get

*EndpointGroup

acs:ga:{#regionId}:{#accountId}:endpointgroup/{#endpointGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Only cn-hangzhou is supported.	cn-hangzhou
EndpointGroupId	string	Yes	The ID of the endpoint group that you want to query.	epg-bp14sz7ftcwwjgrdm****

Response elements

Element	Type	Description	Example
	object	The response information list.
HealthCheckIntervalSeconds	integer	The interval between health checks, in seconds.	3
TrafficPercentage	integer	The traffic percentage routed to different endpoint groups when a listener has multiple endpoint groups.	100
EndpointGroupId	string	The ID of the endpoint group.	epg-bp14sz7ftcwwjgrdm****
Description	string	The description of the endpoint group.	group1
EndpointGroupIpList	array	The list of active endpoint IP addresses in the endpoint group. Important For endpoint groups that use private network back-to-origin routing, the console displays only the private network back-to-origin addresses and no longer displays public network addresses. If the network connectivity type of the backend service in the endpoint group changes, such as from a private network to a public network, or to a hybrid of public and private networks, monitor the changes in back-to-origin addresses promptly and perform synchronization of the ACL list of the backend service.
	string	An active endpoint IP address in the endpoint group.	101.XX.XX.22
EndpointGroupUnconfirmedIpList	array	The list of new endpoint group IP addresses pending confirmation after the Alibaba Cloud Global Accelerator (GA) instance is upgraded.
	string	The list of new endpoint group IP addresses pending confirmation after the Alibaba Cloud Global Accelerator (GA) instance is upgraded.	101.XX.XX.22
RequestId	string	The ID of the request.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
HealthCheckPath	string	The health check path.	/healthcheck
ThresholdCount	integer	The number of consecutive failed health checks required to mark an endpoint as unhealthy.	3
Name	string	The name of the endpoint group.	group1
EndpointGroupRegion	string	The ID of the region to which the endpoint group belongs.	cn-hangzhou
State	string	The state of the endpoint group. Valid values: init: Initializing. active: Normal. updating: Updating. deleting: Deleting.	active
HealthCheckProtocol	string	The health check protocol. Valid values: tcp or TCP: TCP protocol. http or HTTP: HTTP protocol. https or HTTPS: HTTPS protocol.	tcp
HealthCheckPort	integer	The health check port.	20
EndpointConfigurations	array<object>	The endpoint configurations.
	object	The endpoint configurations.
Type	string	The endpoint type. Valid values: Domain: Custom domain name. Ip: Custom IP address. IpTarget: Custom private IP address. PublicIp: Alibaba Cloud public IP address. ECS: Alibaba Cloud ECS instance. SLB: Alibaba Cloud SLB instance. ALB: Alibaba Cloud ALB instance. OSS: Alibaba Cloud OSS instance. ENI: Alibaba Cloud elastic network interfaces (ENIs), which act as a network interface controller (NIC). NLB: Alibaba Cloud NLB instance.	Ip
EnableClientIPPreservation	boolean	Specifies whether client IP address preservation is enabled by using the automatic retrieval method. Valid values: true: Client IP address preservation is enabled. false: Client IP address preservation is disabled.	false
Weight	integer	The weight of the endpoint.	255
ProbeProtocol	string	The latency probing protocol. Valid values: tcp: TCP. icmp: ICMP.	tcp
Endpoint	string	The IP address, domain name, or instance ID of the endpoint.	120.XX.XX.21
EnableProxyProtocol	boolean	Specifies whether client IP address preservation is enabled by using the Proxy Protocol. Valid values: true: Client IP address preservation is enabled by using the Proxy Protocol. false: Client IP address preservation is not enabled by using the Proxy Protocol.	false
ProbePort	integer	The probing port for latency monitoring.	80
SubAddress	string	The private IP address of the elastic network interface (ENI).	172.168.XX.XX
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-hp30gtnxkfxj1l2xt****
VSwitchIds	array	The list of vSwitches in the VPC.
	string	The ID of the vSwitch.	vsw-bp1nx4sxxe1nnr1ja****
Provider	string	The configuration provider.	BAILIAN
ApiKeys	array	The API keys in the endpoint configuration.
	string	The first API key in the endpoint configuration.	sk-*******
PortOverrides	array<object>	The port mapping relationships.
	object	The port mapping relationships.
ListenerPort	integer	The listener port.	443
EndpointPort	integer	The endpoint port.	80
EndpointRequestProtocol	string	The backend service protocol. This refers to the network protocol, not the Terms of Service. Valid values: HTTP HTTPS	HTTP
EndpointProtocolVersion	string	The backend service protocol version. This refers to the network protocol version, not the Terms of Service. Valid values: HTTP1.1 HTTP2	HTTP2
EndpointGroupType	string	The endpoint group type. Valid values: default: Default endpoint group. virtual: Virtual endpoint group.	default
ForwardingRuleIds	array	The IDs of the forwarding rules associated with the endpoint group.
	string	The IDs of the forwarding rules associated with the endpoint group.	frule-bp19a3t3yzr21q3****
AcceleratorId	string	The instance ID of the Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
ListenerId	string	The instance ID of the listener.	lsr-bp1bpn0kn908w4nbw****
SlsRegion	string	The Simple Log Service region.	cn-hangzhou
SlsProjectName	string	The name of the Simple Log Service project.	pn-01
SlsLogStoreName	string	The name of the Simple Log Service Logstore.	lsn-01
AccessLogSwitch	string	The log binding status. Valid values: on: Bound. off: Unbound. binding: Binding. unbinding: Unbinding.	on
EnableAccessLog	boolean	Specifies whether access logging is enabled. Valid values: true: Access logging is enabled. false: Access logging is disabled.	true
HealthCheckEnabled	boolean	Specifies whether health checks are enabled. Valid values: true: Health checks are enabled. false: Health checks are disabled.	true
ServiceId	string	The ID of the service provider to which the managed instance belongs. Note This parameter is valid only when the ServiceManaged parameter is set to True.	ALB
ServiceManaged	boolean	Specifies whether the instance is a managed instance. Valid values: true: The instance is a managed instance. false: The instance is not a managed instance.	true
ServiceManagedInfos	array<object>	The list of action policies that users can execute on this managed instance. Note This parameter is valid only when the ServiceManaged parameter is set to True. When an instance is in the managed state, user operations on the instance are restricted, and certain operations are prohibited.
	object	The list of action policies that users can execute on the managed instance.
Action	string	The name of the managed policy action. Valid values: Create: Create an instance. Update: Update the current instance. Delete: Delete the current instance. Associate: Reference or be referenced by the current instance. UserUnmanaged: Remove the instance from management. CreateChild: Create a child resource under the current instance.	Update
ChildType	string	The child resource type. Valid values: Listener: Listener resource. IpSet: Acceleration region resource. EndpointGroup: Endpoint group resource. ForwardingRule: Forwarding rule resource. Endpoint: Endpoint resource. EndpointGroupDestination: Endpoint group protocol mapping resource under a custom routing listener. EndpointPolicy: Endpoint access policy resource under a custom routing listener. Note This parameter is valid only when the Action parameter is set to CreateChild.	Listener
IsManaged	boolean	Specifies whether the managed policy action is managed. Valid values: true: The managed policy action is managed. Users do not have the permissions to perform the operation specified by Action on the managed instance. false: The managed policy action is not managed. Users can perform the operation specified by Action on the managed instance.	false
Tags	array<object>	The tags of the endpoint group.
	object	The tags of the endpoint group.
Key	string	The tag key of the endpoint group.	test-key
Value	string	The tag value of the endpoint group.	test-value
HealthCheckHost	string	The domain name for health checks.	www.taobao.com
AccessLogRecordCustomizedHeadersEnabled	boolean	Specifies whether access logs carry custom header fields. Valid values: true: Yes. false (default): No. Note You can set this parameter to true only when the access log switch AccessLogEnabled for the instance is turned on.
AccessLogRecordCustomizedHeaderList	array	The list of custom header field names carried in access logs.
	string	The list of custom header field names carried in access logs.	['sda', 'dsaasdd', 'dsada']
EndpointIpVersion	string	The backend IP address protocol. Valid values: IPv4 (default): GA uses only IPv4 addresses to communicate with the endpoint service. IPv6: GA uses only IPv6 addresses to communicate with the endpoint service. ProtocolAffinity: The IP protocol used by GA to communicate with the endpoint service is the same as the IP protocol used in client requests.	IPv4
EndpointPrivateIpList	array<object>	The list of private IP addresses of backend nodes.
	object
PrivateIp	string	The private IP address.	172.16.49.***
VSwitchId	string	The ID of the vSwitch in the VPC.	gsw-bp1rsfd2frym**
CIDR	string	The CIDR block in the private endpoint IP list.	10.0.0.0/24
HealthCheckSuccessCodes	string	The success status codes for health checks.	http_2xx,http_3xx
HealthCheckMethod	string	The health check method.	GET
ProxyTunnel	object	The proxy tunnel configuration.
ConnectAuthPrefix	string	The connection authentication prefix.	prefix-auth
ConnectAuthSuffix	string	The connection authentication suffix.	suffix-auth
ConnectSessionHashHdr	string	The connection session hash header.	X-Session-Hash
ConnectTunnelTimeout	integer	The connection tunnel timeout period.	5000
TunnelServerPort	integer	The tunnel server port.	8443
TunnelServerType	string	The tunnel server type.	domain
TunnelServer	string	The tunnel server configuration.	tunnel.example.com

Examples

Success response

JSON format

{
  "HealthCheckIntervalSeconds": 3,
  "TrafficPercentage": 100,
  "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": 255,
      "ProbeProtocol": "tcp",
      "Endpoint": "120.XX.XX.21",
      "EnableProxyProtocol": false,
      "ProbePort": 80,
      "SubAddress": "172.168.XX.XX",
      "VpcId": "vpc-hp30gtnxkfxj1l2xt****",
      "VSwitchIds": [
        "vsw-bp1nx4sxxe1nnr1ja****"
      ],
      "Provider": "BAILIAN",
      "ApiKeys": [
        "sk-*******"
      ]
    }
  ],
  "PortOverrides": [
    {
      "ListenerPort": 443,
      "EndpointPort": 80
    }
  ],
  "EndpointRequestProtocol": "HTTP",
  "EndpointProtocolVersion": "HTTP2",
  "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"
    }
  ],
  "HealthCheckHost": "www.taobao.com",
  "AccessLogRecordCustomizedHeadersEnabled": false,
  "AccessLogRecordCustomizedHeaderList": [
    "['sda', 'dsaasdd', 'dsada']"
  ],
  "EndpointIpVersion": "IPv4",
  "EndpointPrivateIpList": [
    {
      "PrivateIp": "172.16.49.***",
      "VSwitchId": "gsw-bp1rsfd2frym**",
      "CIDR": "10.0.0.0/24"
    }
  ],
  "HealthCheckSuccessCodes": "http_2xx,http_3xx",
  "HealthCheckMethod": "GET",
  "ProxyTunnel": {
    "ConnectAuthPrefix": "prefix-auth",
    "ConnectAuthSuffix": "suffix-auth",
    "ConnectSessionHashHdr": "X-Session-Hash",
    "ConnectTunnelTimeout": 5000,
    "TunnelServerPort": 8443,
    "TunnelServerType": "domain",
    "TunnelServer": "tunnel.example.com"
  }
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.