使用DescribeEndpointGroup API查詢終端節點群組資訊-Global Acceleration-阿里雲 - Global Accelerator

查詢指定終端節點群組資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ga:DescribeEndpointGroup

get

*EndpointGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	Global Acceleration執行個體所屬地區 ID，僅取值cn-hangzhou。	cn-hangzhou
EndpointGroupId	string	是	要查詢的終端節點群組的 ID。	epg-bp14sz7ftcwwjgrdm****

返回參數

名稱	類型	描述	樣本值
	object	返回資訊列表。
HealthCheckIntervalSeconds	integer	健全狀態檢查的時間間隔，單位為秒。	3
TrafficPercentage	integer	監聽執行個體有多個終端節點群組時，配置到不同終端節點群組的流量比例。	100
EndpointGroupId	string	終端節點群組 ID。	epg-bp14sz7ftcwwjgrdm****
Description	string	終端節點群組的描述資訊。	group1
EndpointGroupIpList	array	終端節點群組活躍的終端節點 IP 列表。重要私網回源類型的終端節點群組在控制台僅展示私網回源地址，不再展示公網地址。如果終端節點群組後端服務的網路連接類型發生變更（例如由私網變更為公網，或調整為公私網混合回源），請及時關注回源地址的變化，並同步更新後端服務的 ACL 列表。
	string	終端節點群組活躍的終端節點 IP 列表。	101.XX.XX.22
EndpointGroupUnconfirmedIpList	array	Global Acceleration執行個體升級後新增待確認的終端節點群組 IP 列表。
	string	Global Acceleration執行個體升級後新增待確認的終端節點群組 IP 列表。	101.XX.XX.22
RequestId	string	請求 ID。	6FEA0CF3-D3B9-43E5-A304-D217037876A8
HealthCheckPath	string	健全狀態檢查路徑。	/healthcheck
ThresholdCount	integer	健全狀態檢查判定終端節點為不健康的次數。	3
Name	string	終端節點群組的名稱。	group1
EndpointGroupRegion	string	終端節點群組所屬的地區 ID。	cn-hangzhou
State	string	終端節點群組的狀態。 init：初始化。 active：正常。 updating：更新中。 deleting：刪除中。	active
HealthCheckProtocol	string	健全狀態檢查的協議。 tcp 或 TCP：TCP 協議。 http 或 HTTP：HTTP 協議。 https 或 HTTPS：HTTPS 協議。	tcp
HealthCheckPort	integer	健全狀態檢查的連接埠。	20
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	終端節點的權重。	255
ProbeProtocol	string	時延探測協議。 tcp：TCP 協議。 icmp：ICMP 協議。	tcp
Endpoint	string	終端節點的 IP、網域名稱或執行個體 ID。	120.XX.XX.21
EnableProxyProtocol	boolean	是否使用 ProxyProtocol 方式開啟了保持用戶端源 IP 功能。 true：使用 ProxyProtocol 方式開啟了保持用戶端源 IP 功能。 false：未使用 ProxyProtocol 方式開啟保持用戶端源 IP 功能。	false
ProbePort	integer	延時監控的探測連接埠。	80
SubAddress	string	彈性網卡的私網 IP 位址。	172.168.XX.XX
VpcId	string	專用網路 ID。	vpc-hp30gtnxkfxj1l2xt****
VSwitchIds	array	VPC 下的交換器列表。
	string	虛擬交換器 ID。	vsw-bp1nx4sxxe1nnr1ja****
Provider	string	配置項提供者	BAILIAN
ApiKeys	array	端點配置中的 API 金鑰
	string	端點配置中的第一個 API 金鑰	sk-*******
PortOverrides	array<object>	連接埠映射關係。
	object	連接埠映射關係。
ListenerPort	integer	監聽連接埠。	443
EndpointPort	integer	終端節點連接埠。	80
EndpointRequestProtocol	string	後端服務合約。 HTTP HTTPS	HTTP
EndpointProtocolVersion	string	後端服務合約版本。 HTTP1.1 HTTP2	HTTP2
EndpointGroupType	string	終端節點群組類型。 default：預設終端節點群組。 virtual：虛擬終端節點群組。	default
ForwardingRuleIds	array	終端節點群組關聯的轉寄策略 ID。
	string	終端節點群組關聯的轉寄策略 ID。	frule-bp19a3t3yzr21q3****
AcceleratorId	string	Global Acceleration執行個體 ID。	ga-bp1odcab8tmno0hdq****
ListenerId	string	監聽執行個體 ID。	lsr-bp1bpn0kn908w4nbw****
SlsRegion	string	SLS 地區。	cn-hangzhou
SlsProjectName	string	SLS 專案名稱。	pn-01
SlsLogStoreName	string	SLS 日誌庫名稱。	lsn-01
AccessLogSwitch	string	日誌綁定狀態。 on：已綁定。 off：未綁定。 binding：綁定中。 unbinding：解除綁定中。	on
EnableAccessLog	boolean	是否開啟了訪問日誌。 true：開啟訪問日誌。 false：關閉訪問日誌。	true
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
AccessLogRecordCustomizedHeadersEnabled	boolean	訪問日誌是否開啟攜帶自訂頭欄位。取值： true：是。 false（預設值）：否。說明只有執行個體訪問日誌開關 AccessLogEnabled 開啟時，才能設定此參數為 true。
AccessLogRecordCustomizedHeaderList	array	訪問日誌攜帶自訂頭欄位名稱列表
	string	訪問日誌攜帶自訂頭欄位名稱列表	['sda', 'dsaasdd', 'dsada']
EndpointIpVersion	string	後端 IP 位址協議。取值： IPv4：（預設值）：GA 僅使用 IPv4 地址與終端節點服務通訊。 IPv6：GA 僅使用 IPv6 地址與終端節點服務通訊。 ProtocolAffinity：GA 與終端節點服務通訊的 IP 協議與用戶端請求使用的 IP 協議相同。	IPv4
EndpointPrivateIpList	array<object>	後端節點私人 IP 列表。
	object
PrivateIp	string	私網 IP。	172.16.49.***
VSwitchId	string	VPC 下的交換器 ID	gsw-bp1rsfd2frym**
CIDR	string

樣本

正常返回樣本

JSON格式

{
  "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": true,
  "AccessLogRecordCustomizedHeaderList": [
    "['sda', 'dsaasdd', 'dsada']"
  ],
  "EndpointIpVersion": "IPv4",
  "EndpointPrivateIpList": [
    {
      "PrivateIp": "172.16.49.***",
      "VSwitchId": "gsw-bp1rsfd2frym**",
      "CIDR": ""
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	處理請求時出現錯誤，請稍後重試。

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

變更歷史

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