調用ListEndpointGroups擷取終端節點群組列表-Global Acceleration-阿里雲 - Global Accelerator

查詢終端節點群組列表。

調試

您可以在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
EndpointGroupRegion	string	否

返回參數

名稱	類型	描述	樣本值
	object	返回資訊列表。
TotalCount	integer	列表項目數。	1
PageSize	integer	分頁查詢時每頁的列數。	10
RequestId	string	請求 ID。	A052D49E-CCC2-41DB-816C-DC3381503194
PageNumber	integer	列表的頁碼。	1
EndpointGroups	array<object>	終端節點群組設定資訊。
	array<object>	終端節點群組設定資訊。
EndpointGroupId	string	終端節點群組 ID。	epg-bp16jdc00bhe97sr5****
EndpointGroupIpList	array	終端節點群組出公網 IP 列表。重要私有網路回源類型的終端節點群組在主控台僅展示私有網路回源位址，不再展示公用網路位址。如果終端節點群組後端服務的網路連線類型發生變更（例如由私有網路變更為公用網路，或調整為公用網路與私有網路混合回源），請及時關注回源位址的變化，並同步更新後端服務的 ACL 列表。
	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。 IpTarget：自訂私有網路 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
EnableProxyProtocol	boolean	是否使用 ProxyProtocol 方式開啟了保持用戶端來源 IP 功能。 true：使用 ProxyProtocol 方式開啟了保持用戶端來源 IP 功能。 false：未使用 ProxyProtocol 方式開啟保持用戶端來源 IP 功能。
ProbePort	integer	延遲監控的探測連接埠。	80
EndpointId	string	終端節點 ID。	ep-bp1d2utp8qqe2a44t****
SubAddress	string	彈性網卡的私有網路 IP 位址。	172.168.XX.XX
VpcId	string	專有網路 ID。	vpc-8vbhucmd5b2q2fpqqu****
VSwitchIds	array	VPC 下的交換器列表。
	string	虛擬交換器 ID。	vsw-hp3xwc2aebg2u30ln****
Provider	string	提供者資訊。	BAILIAN
ApiKeys	array	終端節點設定中的 API 金鑰。
	string	終端節點群組中第一個 API 金鑰。	sk-*******
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 版本。	HTTP1.1
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
HealthCheckHost	string	健康檢查網域名稱。	www.taobao.com
EndpointIpVersion	string	後端 IP 位址通訊協定。取值： IPv4：（預設值）：GA 僅使用 IPv4 位址與終端節點服務通訊。 IPv6：GA 僅使用 IPv6 位址與終端節點服務通訊。 ProtocolAffinity：GA 與終端節點服務通訊的 IP 通訊協定與用戶端請求使用的 IP 通訊協定相同。	IPv4
EndpointPrivateIpList	array<object>	後端節點私有 IP 列表。
	object
PrivateIp	string	私有 IP。	172.19.115.37
VSwitchId	string	VPC 下的交換器 ID。	gsw-0jl6tmriqep1ga***
CIDR	string
HealthCheckSuccessCodes	string
HealthCheckMethod	string
ProxyTunnel	object
ConnectAuthPrefix	string
ConnectAuthSuffix	string
ConnectSessionHashHdr	string
ConnectTunnelTimeout	integer
TunnelServerPort	integer
TunnelServerType	string
TunnelServer	string

樣本

正常返回樣本

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",
          "EnableProxyProtocol": false,
          "ProbePort": 80,
          "EndpointId": "ep-bp1d2utp8qqe2a44t****",
          "SubAddress": "172.168.XX.XX",
          "VpcId": "vpc-8vbhucmd5b2q2fpqqu****",
          "VSwitchIds": [
            "vsw-hp3xwc2aebg2u30ln****"
          ],
          "Provider": "BAILIAN",
          "ApiKeys": [
            "sk-*******"
          ]
        }
      ],
      "PortOverrides": [
        {
          "ListenerPort": 443,
          "EndpointPort": 80
        }
      ],
      "ForwardingRuleIds": [
        "frule-bp19a3t3yzr21q3****"
      ],
      "EndpointGroupType": "default",
      "EndpointRequestProtocol": "HTTP",
      "EndpointProtocolVersion": "HTTP1.1",
      "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"
        }
      ],
      "HealthCheckHost": "www.taobao.com",
      "EndpointIpVersion": "IPv4",
      "EndpointPrivateIpList": [
        {
          "PrivateIp": "172.19.115.37",
          "VSwitchId": "gsw-0jl6tmriqep1ga***",
          "CIDR": ""
        }
      ],
      "HealthCheckSuccessCodes": "",
      "HealthCheckMethod": "",
      "ProxyTunnel": {
        "ConnectAuthPrefix": "",
        "ConnectAuthSuffix": "",
        "ConnectSessionHashHdr": "",
        "ConnectTunnelTimeout": 0,
        "TunnelServerPort": 0,
        "TunnelServerType": "",
        "TunnelServer": ""
      }
    }
  ]
}

錯誤碼

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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。