ListEndpointGroups - 查询终端节点组列表 - 全球加速

调用ListEndpointGroups接口查询终端节点组列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ga:ListEndpointGroups	list	EndpointGroup acs:ga:{#regionId}:{#accountId}:endpointgroup/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	全球加速实例所在的地域 ID，仅取值cn-hangzhou。	cn-hangzhou
PageNumber	integer	否	列表的页码，默认值：1。	1
PageSize	integer	否	分页查询时每页的行数。最大值：50，默认值：10。	10
AcceleratorId	string	是	全球加速实例 ID。	ga-bp1odcab8tmno0hdq****
ListenerId	string	否	监听实例 ID。	lsr-bp1bpn0kn908w4nbw****
EndpointGroupType	string	否	终端节点组类型。取值： default：默认终端节点组。 virtual：虚拟终端节点组。空值：表示查询所有默认终端节点组和虚拟终端节点组。	virtual
AccessLogSwitch	string	否	是否开启访问日志。取值： on：开启访问日志。 off（默认值）：关闭访问日志。	on
EndpointGroupId	string	否	终端节点组 ID。	epg-bp16jdc00bhe97sr5****
Tag	array<object>	否	终端节点组的标签。
	object	否	终端节点组的标签。
Key	string	否	终端节点组的标签键。一旦输入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。最多支持输入 20 个标签键。	test-key
Value	string	否	终端节点组的标签值。一旦输入该值，可以为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。最多支持输入 20 个标签值。	test-value

返回参数

名称	类型	描述	示例值
	object	返回信息列表。
TotalCount	integer	列表条目数。	1
PageSize	integer	分页查询时每页的行数。	10
RequestId	string	请求 ID。	A052D49E-CCC2-41DB-816C-DC3381503194
PageNumber	integer	列表的页码。	1
EndpointGroups	array<object>	终端节点组配置信息。
	object	终端节点组配置信息。
EndpointGroupId	string	终端节点组 ID。	epg-bp16jdc00bhe97sr5****
EndpointGroupIpList	array	终端节点组出公网 IP 列表。
	string	终端节点组出公网 IP 列表。	47.1.XX.XX
EndpointGroupUnconfirmedIpList	array	全球加速实例升级后新增待确认的终端节点组 IP 列表。
	string	全球加速实例升级后新增待确认的终端节点组 IP 列表。	47.1.XX.XX
State	string	终端节点组的状态。 init：初始化。 active：正常。 updating：更新中。 deleteing：删除中。	active
HealthCheckPath	string	健康检查路径。	/healthcheck
EndpointGroupRegion	string	终端节点组所属的地域 ID。	cn-hangzhou
HealthCheckIntervalSeconds	integer	健康检查的时间间隔，单位：秒。	3
TrafficPercentage	integer	监听有多个终端节点组时，配置到不同终端节点组的流量比例。	100
HealthCheckProtocol	string	健康检查的协议。 tcp 或 TCP：TCP 协议。 http 或 HTTP：HTTP 协议。 https 或 HTTPS：HTTPS 协议。	tcp
ThresholdCount	integer	健康检查判定终端节点为不健康的次数。	3
ListenerId	string	监听实例 ID。	lsr-bp1bpn0kn908w4nbw****
AcceleratorId	string	全球加速实例 ID。	ga-bp1odcab8tmno0hdq****
EndpointConfigurations	array<object>	终端节点配置信息。
	object	终端节点配置信息。
Type	string	终端节点类型。 Domain：自定义域名。 Ip：自定义 IP。 PublicIp：阿里云公网 IP。 ECS：阿里云 ECS 实例。 SLB：阿里云 SLB 实例。 ALB：阿里云 ALB 实例。 OSS：阿里云 OSS 实例。 ENI：阿里云弹性网卡。 NLB：阿里云 NLB 实例。	Ip
EnableClientIPPreservation	boolean	是否开启了保持客户端源 IP 功能。 true：开启了保持客户端源 IP 功能。 false：未开启保持客户端源 IP 功能。	false
Weight	integer	终端节点的权重。	20
ProbeProtocol	string	延时监控的探测协议。 icmp：ICMP 协议。 tcp：TCP 协议。	tcp
Endpoint	string	终端节点的 IP、域名或实例 ID。	47.1.XX.XX
ProbePort	integer	延时监控的探测端口。	80
EndpointId	string	终端节点 ID。	ep-bp1d2utp8qqe2a44t****
SubAddress	string	弹性网卡的私网 IP 地址。	172.168.XX.XX
PortOverrides	array<object>	端口映射关系。
	object	端口映射关系。
ListenerPort	integer	监听端口。	443
EndpointPort	integer	终端节点端口。	80
ForwardingRuleIds	array	终端节点组关联的转发策略 ID。
	string	终端节点组关联的转发策略 ID。	frule-bp19a3t3yzr21q3****
EndpointGroupType	string	终端节点组类型。 default：默认终端节点组。 virtual：虚拟终端节点组。	default
EndpointRequestProtocol	string	后端服务协议。 HTTP：HTTP 协议。 HTTPS：HTTPS 协议。	HTTP
EndpointProtocolVersion	string	后端服务协议版本。 HTTP1.1：HTTP1.1 版本。 HTTP2：HTTP2 版本。
Description	string	终端节点组的描述信息。	group1
Name	string	终端节点组的名称。	group1
HealthCheckPort	integer	健康检查的端口。	10
HealthCheckEnabled	boolean	是否开启了健康检查。 true：开启健康检查。 false：关闭健康检查。	true
ServiceId	string	托管实例所属的服务方 ID。说明仅在 ServiceManaged 参数为 True 时有效。	ALB
ServiceManaged	boolean	是否为托管实例。取值： true：是托管实例。 false：不是托管实例。	true
ServiceManagedInfos	array<object>	用户在此托管实例下可执行的动作策略列表。说明仅在 ServiceManaged 参数为 True 时有效。当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。
	object	用户在此托管实例下可执行的动作策略列表。
Action	string	托管策略动作名称。 Create：创建实例。 Update：更新当前实例。 Delete：删除当前实例。 Associate：引用/被引用当前实例。 UserUnmanaged：用户解托管实例。 CreateChild：在当前实例下创建子资源。	Update
ChildType	string	子资源类型。 Listener：监听资源。 IpSet：加速地域资源。 EndpointGroup：终端节点组资源。 ForwardingRule：转发策略资源。 Endpoint：终端节点资源。 EndpointGroupDestination：自定义路由监听下的终端节点组协议映射资源。 EndpointPolicy：自定义路由监听下的终端节点通行策略资源。说明仅在 Action 参数为 CreateChild 时有效。	Listener
IsManaged	boolean	托管策略动作是否被托管，取值： true：托管策略动作被托管，用户无权在托管实例下执行 Action 指定的操作。 false：托管策略动作未被托管，用户可在托管实例下执行 Action 指定的操作。	false
Tags	array<object>	终端节点组的标签。
	object	终端节点组的标签。
Key	string	终端节点组的标签键。	test-key
Value	string	终端节点组的标签值。	test-value

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "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": 100,
      "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****",
          "SubAddress": "172.168.XX.XX"
        }
      ],
      "PortOverrides": [
        {
          "ListenerPort": 443,
          "EndpointPort": 80
        }
      ],
      "ForwardingRuleIds": [
        "frule-bp19a3t3yzr21q3****"
      ],
      "EndpointGroupType": "default",
      "EndpointRequestProtocol": "HTTP",
      "EndpointProtocolVersion": "",
      "Description": "group1",
      "Name": "group1",
      "HealthCheckPort": 10,
      "HealthCheckEnabled": true,
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ],
      "Tags": [
        {
          "Key": "test-key",
          "Value": "test-value"
        }
      ]
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	NoPermission	No permissions.	无权限
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	处理请求时出现错误，请稍后重试。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-07-20	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-09-14	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-08-15	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-07-20	OpenAPI 错误码发生变更	查看变更详情
2023-04-27	OpenAPI 错误码发生变更	查看变更详情
2021-04-27	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情