UpdateEndpointGroup - 修改終端節點群組的業務配置 - Global Accelerator

調用UpdateEndpointGroup介面修改終端節點群組配置資訊。

介面說明

UpdateEndpointGroup 介面屬於非同步介面，即系統會先返回一個請求 ID，但終端節點群組配置資訊並未修改完成，系統背景修改任務仍在進行。您可以調用 DescribeEndpointGroup 查詢終端節點群組的狀態：
- 當終端節點群組處於 updating 狀態時，表示終端節點群組配置資訊正在修改中，在該狀態下，您只能執行查詢操作，不能執行其他動作。
- 當終端節點群組處於 active 狀態時，表示終端節點群組配置資訊修改完成。
UpdateEndpointGroup 介面不支援在同一個Global Acceleration執行個體內並發修改終端節點群組配置資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ga:UpdateEndpointGroup

update

*EndpointGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	Global Acceleration執行個體所在的地區 ID，僅取值cn-hangzhou。	cn-hangzhou
ClientToken	string	否	用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	123e4567-e89b-12d3-a456-426655440000
EndpointGroupId	string	是	終端節點群組 ID。	epg-bp1dmlohjjz4kqaun****
Name	string	否	終端節點群組的名稱。名稱長度為 1~128 個字元，以大小寫字母或中文開頭，可包含數字、半形句號（.）底線（_）和短劃線（-）。	group1
Description	string	否	終端節點群組描述資訊。描述長度最大 200 字元，不能以`http://`和`https://`開頭。	EndpointGroup
EndpointGroupRegion	string	是	終端節點群組所屬的地區 ID。	cn-hangzhou
TrafficPercentage	integer	否	監聽有多個終端節點群組時的權重。	20
HealthCheckIntervalSeconds	integer	否	健全狀態檢查的時間間隔。單位：秒。取值範圍：1-50。	3
HealthCheckPath	string	否	健全狀態檢查路徑。	/healthcheck
HealthCheckPort	integer	否	健全狀態檢查的連接埠。取值範圍：1~65535。	20
HealthCheckProtocol	string	否	健全狀態檢查的協議。取值： tcp 或 TCP：TCP 協議。 http 或 HTTP：HTTP 協議。 https 或 HTTPS：HTTPS 協議。	HTTPS
ThresholdCount	integer	否	針對健全狀態檢查狀態變化所需要的連續健全狀態檢查次數，即從成功到失敗的連續健全狀態檢查失敗次數或從失敗到成功的連續健全狀態檢查成功次數。取值範圍：2~10。	3
EndpointConfigurations	array<object>	否	終端節點配置資訊。
	object	否	終端節點配置資訊。
Type	string	是	終端節點類型，取值： Domain：自訂網域名。 Ip：自訂 IP。 IpTarget：自訂私網 IP。 PublicIp：阿里雲公網 IP。 ECS：阿里雲 ECS 執行個體。 SLB：阿里雲 SLB 執行個體。 ALB：阿里雲 ALB 執行個體。 OSS：阿里雲 OSS 執行個體。 ENI：阿里雲彈性網卡。 NLB：阿里雲 NLB 執行個體。說明終端節點類型取值為 ECS、ENI、SLB、ALB、NLB 或 IpTarget 時，如果服務關聯角色不存在，系統會自動建立一個名稱為 AliyunServiceRoleForGaVpcEndpoint 的服務關聯角色。終端節點類型取值為 ALB 時，如果服務關聯角色不存在，系統會自動建立一個名稱為 AliyunServiceRoleForGaAlb 的服務關聯角色。終端節點類型取值為 OSS 時，如果服務關聯角色不存在，系統會自動建立一個名稱為 AliyunServiceRoleForGaOss 的服務關聯角色。終端節點類型取值為 NLB 時，如果服務關聯角色不存在，系統會自動建立一個名稱為 AliyunServiceRoleForGaNlb 的服務關聯角色。說明更多資訊，請參見服務關聯角色。	Ip
EnableClientIPPreservation	boolean	否	是否使用自動擷取方式開啟保持用戶端源 IP 功能，取值： true：開啟保持用戶端源 IP 功能。 false（預設值）：不開啟保持用戶端源 IP 功能。說明 UDP/TCP 監聽對應的終端節點群組預設不開啟保持用戶端源 IP，您可根據業務需要配置。 HTTP（S）監聽對應的終端節點群組預設開啟保持用戶端源 IP，通過 X-Forwarded-For 頭欄位擷取。不支援關閉。 EnableClientIPPreservation 與 EnableProxyProtocol 不能同時為 true。更多資訊請參考保持用戶端源 IP。	false
Weight	integer	是	終端節點的權重。取值範圍：0~255。說明如果某個終端節點的權重設定為 0，Global Acceleration將終止向該終端節點分發流量，請您謹慎操作。	20
EnableProxyProtocol	boolean	否	是否使用 ProxyProtocol 方式開啟保持用戶端源 IP 功能，取值： true：開啟保持用戶端源 IP 功能。 false（預設值）：不開啟保持用戶端源 IP 功能。說明僅支援 TCP 監聽對應的終端節點群組配置。 EnableClientIPPreservation 與 EnableProxyProtocol 不能同時為 true。更多資訊請參考保持用戶端源 IP。	false
Endpoint	string	是	根據 Type（終端節點類型）輸入對應的 IP、網域名稱或執行個體 ID。	120.XX.XX.21
SubAddress	string	否	彈性網卡的私網 IP 位址。說明當終端節點類型為 ENI 時，可以選擇配置該參數，如果不配置預設為 ENI 的主私網 IP 位址。	172.168.XX.XX
VpcId	string	否	專用網路 ID。在智能路由類型監聽的某個終端節點群組中，您最多可以輸入 1 個專用網路 ID。說明僅當終端節點類型為 IpTarget 時有效且必填。	vpc-2zen6t0u7xhm0k5iz****
VSwitchIds	array	否	VPC 下的交換器列表。
	string	否	虛擬交換器 ID。在智能路由類型監聽的某個終端節點群組中，您最多可以輸入 2 個虛擬交換器 ID。說明僅當終端節點類型為 IpTarget 時有效且必填。該虛擬交換器屬於 VpcId 參數指定的專用網路。	vsw-2ze2dbtkxabpvpqxc****
EndpointRequestProtocol	string	否	後端服務合約。取值： HTTP HTTPS 說明僅為 HTTP 或 HTTPS 協議的監聽執行個體建立終端節點群組時才支援配置該項。對於 HTTP 協議的監聽執行個體，後端服務合約支援且僅支援 HTTP。	HTTP
EndpointProtocolVersion	string	否	後端服務合約版本。取值： HTTP1.1 HTTP2 說明僅當 EndpointRequestProtocol（後端服務合約）值為 HTTPS 時，支援配置終端節點後端服務合約版本。	HTTP1.1
PortOverrides	array<object>	否	連接埠映射關係。
	object	否	連接埠映射關係。
ListenerPort	integer	否	配置連接埠映射中的監聽連接埠。說明對於 TCP 監聽：虛擬終端節點群組不支援配置連接埠映射。如果監聽下已存在虛擬終端節點群組，則預設終端節點群組無法配置連接埠映射。如果預設終端節點群組已配置連接埠映射，則無法添加虛擬終端節點群組。配置連接埠映射後，後續監聽變更時有以下限制：除 HTTP 和 HTTPS 之間的協議切換以外，不支援修改監聽協議。監聽連接埠：您修改的監聽連接埠範圍必須包含當前所配置連接埠映射的全量監聽連接埠。例如，當監聽連接埠範圍為 80-82，並配置連接埠映射至終端節點連接埠 100-102 時，後續修改監聽連接埠範圍時，不支援修改為 80-81。	443
EndpointPort	integer	否	配置連接埠映射中的終端節點連接埠。	80
HealthCheckEnabled	boolean	否	是否開啟健全狀態檢查。取值： true：開啟健全狀態檢查。 false（預設值）：關閉健全狀態檢查。	true
HealthCheckHost	string	否

返回參數

名稱	類型	描述	樣本值
	object	返回資訊列表。
RequestId	string	請求 ID。	6FEA0CF3-D3B9-43E5-A304-D217037876A8

樣本

正常返回樣本

JSON格式

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.	該帳號沒有啟用健全狀態檢查的許可權。
400	NotExist.EndPointGroup	The endpoint group does not exist.	終端節點群組不存在
400	StateError.EndPointGroup	The specified state of endpoint group is invalid.	終端節點群組狀態非法
400	NotExist.Listener	The listener does not exist.	監聽器不存在
400	NotActive.Listener	The state of the listener is not active.	監聽器狀態非穩態
400	NotExist.Accelerator	The accelerated instance does not exist.	加速執行個體不存在。
400	StateError.Accelerator	The state of the accelerated instance is invalid.	加速執行個體狀態非法。
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	終端節點達到Quota限制
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.	使用者沒有建立服務關聯角色的許可權，請聯絡主帳號或許可權管理員授權目前使用者AliyunGlobalAccelerationFullAccess或者建立服務關聯角色的自訂許可權。自訂權限原則的相關資訊包含以下內容：ServiceName為vpcendpoint.ga.aliyuncs.com，服務關聯角色名稱為AliyunServiceRoleForGaVpcEndpoint，執行該操作所需的使用者權限為ram:CreateServiceLinkedRole。
400	EndPointRequestProtocolIllegal.EndpointGroup	endpoint group request protoco is illegal
400	QuotaExceeded.PortOverride	The number of port override exceeds the limit.	連接埠轉寄數量超過限制
400	NotExist.ListenerPort	listener port %s is not exist

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

變更歷史

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