DescribeEndpointGroup-阿里云帮助中心

Queries 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 Global Accelerator instance. Set the value to cn-hangzhou.	cn-hangzhou
EndpointGroupId	string	Yes	The ID of the endpoint group.	epg-bp14sz7ftcwwjgrdm****

Response elements

Element	Type	Description	Example
	object	The response parameters.
HealthCheckIntervalSeconds	integer	The health check interval, in seconds.	3
TrafficPercentage	integer	The percentage of traffic that is distributed to the endpoint group. This parameter is returned only when a listener is associated with multiple endpoint groups.	100
EndpointGroupId	string	The endpoint group ID.	epg-bp14sz7ftcwwjgrdm****
Description	string	The description of the endpoint group.	group1
EndpointGroupIpList	array	The list of active IP addresses of the endpoints in the endpoint group. Important For an endpoint group configured for back-to-source from a private network, the console displays only the private back-to-source IP addresses and not the public IP addresses. If the network connection type for the backend service of the endpoint group changes (for example, from a private network to a public network, or to a mix of private and public networks), you must monitor the changes in the back-to-source IP addresses and update the access control list (ACL) of the backend service accordingly.
	string	The IP address of an active endpoint.	101.XX.XX.22
EndpointGroupUnconfirmedIpList	array	A list of endpoint IP addresses pending confirmation after a Global Accelerator instance upgrade.
	string	The IP address of an endpoint pending confirmation after a Global Accelerator instance upgrade.	101.XX.XX.22
RequestId	string	The request ID.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
HealthCheckPath	string	The path for health check probes.	/healthcheck
ThresholdCount	integer	The number of consecutive failed health checks before an endpoint is marked as unhealthy.	3
Name	string	The name of the endpoint group.	group1
EndpointGroupRegion	string	The region ID where the endpoint group is deployed.	cn-hangzhou
State	string	The status of the endpoint group. init: The endpoint group is being initialized. active: The endpoint group is active. updating: The endpoint group is being updated. deleting: The endpoint group is being deleted.	active
HealthCheckProtocol	string	The protocol used for health checks. tcp or TCP: TCP http or HTTP: HTTP https or HTTPS: HTTPS	tcp
HealthCheckPort	integer	The port used for health checks.	20
EndpointConfigurations	array<object>	The endpoint configurations.
	object	An endpoint configuration.
Type	string	The type of the endpoint. Valid values: Domain: A custom domain name. Ip: A custom IP address. IpTarget: A custom private IP address. PublicIp: An Alibaba Cloud public IP address. ECS: An ECS instance. SLB: An SLB instance. ALB: An ALB instance. OSS: An OSS instance. ENI: An elastic network interface. NLB: An NLB instance.	Ip
EnableClientIPPreservation	boolean	Indicates whether client IP preservation is enabled by using the automatic method. true: Enabled. false: Disabled.	false
Weight	integer	The weight of the endpoint.	255
ProbeProtocol	string	The protocol for latency probing. 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	Indicates whether client IP preservation is enabled using the Proxy Protocol. true: Enabled. false: Disabled.	false
ProbePort	integer	The port used for latency probing.	80
SubAddress	string	The private IP address of the elastic network interface.	172.168.XX.XX
VpcId	string	The VPC ID.	vpc-hp30gtnxkfxj1l2xt****
VSwitchIds	array	A list of VSwitch IDs.
	string	The VSwitch ID.	vsw-bp1nx4sxxe1nnr1ja****
Provider	string	The provider of the endpoint configuration.	BAILIAN
ApiKeys	array	The API keys for the endpoint configuration.
	string	An API key in the endpoint configuration.	sk-*******
PortOverrides	array<object>	The port mapping configuration.
	object	A port mapping configuration.
ListenerPort	integer	The listener port.	443
EndpointPort	integer	The endpoint port.	80
EndpointRequestProtocol	string	The protocol used by the backend service. Valid values: HTTP HTTPS	HTTP
EndpointProtocolVersion	string	The version of the backend service protocol. Valid values: HTTP1.1 HTTP2	HTTP2
EndpointGroupType	string	The type of the endpoint group. Valid values: default: A default endpoint group. virtual: A virtual endpoint group.	default
ForwardingRuleIds	array	The IDs of the associated forwarding rules.
	string	The forwarding rule ID.	frule-bp19a3t3yzr21q3****
AcceleratorId	string	The Global Accelerator instance ID.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The listener ID.	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	The status of the access log configuration. Valid values: on: The access log is configured. off: The access log is not configured. binding: The access log is being configured. unbinding: The access log configuration is being removed.	on
EnableAccessLog	boolean	Indicates whether access logging is enabled. true: Access logging is enabled. false: Access logging is disabled.	true
HealthCheckEnabled	boolean	Indicates whether health checks are enabled. true: Health checks are enabled. false: Health checks are disabled.	true
ServiceId	string	The ID of the service that manages the instance. Note This parameter is returned only if ServiceManaged is set to True.	ALB
ServiceManaged	boolean	Indicates 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>	A list of management states for actions that can be performed on the instance. Note This parameter is returned only if ServiceManaged is set to True. When an instance is managed, some operations may be restricted.
	object	The management state for a specific action.
Action	string	The name of the action on the managed instance. Valid values: Create: Create an instance. Update: Update the instance. Delete: Delete the instance. Associate: Associate the instance. UserUnmanaged: Releases the instance from service management. CreateChild: Create a child resource.	Update
ChildType	string	The type of the child resource. Valid values: Listener: A listener. IpSet: An acceleration region. EndpointGroup: An endpoint group. ForwardingRule: A forwarding rule. Endpoint: An endpoint. EndpointGroupDestination: A protocol mapping for an endpoint group of a custom routing listener. EndpointPolicy: A traffic policy for an endpoint of a custom routing listener. Note This parameter is valid only when Action is set to CreateChild.	Listener
IsManaged	boolean	Indicates whether the action is managed. Valid values: true: The action is managed. You cannot perform this action on the instance. false: The action is not managed. You can perform this action on the instance.	false
Tags	array<object>	A list of tags attached to the endpoint group.
	object	A tag.
Key	string	The tag key.	test-key
Value	string	The tag value.	test-value
HealthCheckHost	string	The domain name used for health checks.	www.taobao.com
AccessLogRecordCustomizedHeadersEnabled	boolean	Specifies whether to record custom header fields in access logs. Valid values: true: Yes. false (default): No. Note You can set this parameter to true only when EnableAccessLog is set to true.
AccessLogRecordCustomizedHeaderList	array	The custom header fields to record in access logs.
	string	A custom header field to record in access logs.	['sda', 'dsaasdd', 'dsada']
EndpointIpVersion	string	The IP version used to connect to the backend service. Valid values: IPv4 (default): Global Accelerator connects to the backend service using IPv4. IPv6: Global Accelerator connects to the backend service using IPv6. ProtocolAffinity: Global Accelerator connects to the backend service using the same IP version as the client request.	IPv4
EndpointPrivateIpList	array<object>	The private IP addresses of the endpoints.
	object
PrivateIp	string	The private IP address.	172.16.49.***
VSwitchId	string	The VSwitch ID in the VPC.	gsw-bp1rsfd2frym**
CIDR	string

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": ""
    }
  ]
}

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.