調用UpdateEndpointGroup接口修改終端節點組配置信息。
接口說明
- UpdateEndpointGroup 接口屬于異步接口,即系統會先返回一個請求 ID,但終端節點組配置信息并未修改完成,系統后臺的修改任務仍在進行。您可以調用 DescribeEndpointGroup 查詢終端節點組的狀態:
- 當終端節點組處于 updating 狀態時,表示終端節點組配置信息正在修改中,在該狀態下,您只能執行查詢操作,不能執行其他操作。
- 當終端節點組處于 active 狀態時,表示終端節點組配置信息修改完成。
- UpdateEndpointGroup 接口不支持在同一個全球加速實例內并發修改終端節點組配置信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ga:UpdateEndpointGroup | update |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 全球加速實例所在的地域 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 字符,不能以 | EndpointGroup |
EndpointGroupRegion | string | 是 | 終端節點組所屬的地域 ID。 | cn-hangzhou |
TrafficPercentage | integer | 否 | 監聽有多個終端節點組時的權重。 | 20 |
HealthCheckIntervalSeconds | integer | 否 | 健康檢查的時間間隔。單位:秒。取值范圍:1-50。 | 3 |
HealthCheckPath | string | 否 | 健康檢查路徑。 | /healthcheck |
HealthCheckPort | integer | 否 | 健康檢查的端口。取值范圍:1~65535。 | 20 |
HealthCheckProtocol | string | 否 | 健康檢查的協議。取值:
| HTTPS |
ThresholdCount | integer | 否 | 針對健康檢查狀態變化所需要的連續健康檢查次數,即從成功到失敗的連續健康檢查失敗次數或從失敗到成功的連續健康檢查成功次數。 取值范圍:2~10。 | 3 |
EndpointConfigurations | array<object> | 否 | 終端節點配置信息。 | |
object | 否 | 終端節點配置信息。 | ||
Type | string | 是 | 終端節點類型,取值:
說明
更多信息,請參見服務關聯角色。 | Ip |
EnableClientIPPreservation | boolean | 否 | 是否使用 TOA 方式開啟保持客戶端源 IP 功能,取值:
| false |
Weight | integer | 是 | 終端節點的權重。 取值范圍:0~255。 說明
如果某個終端節點的權重設置為 0,全球加速將終止向該終端節點分發流量,請您謹慎操作。
| 20 |
EnableProxyProtocol | boolean | 否 | 是否使用 ProxyProtocol 方式開啟保持客戶端源 IP 功能,取值:
| false |
Endpoint | string | 是 | 根據 Type(終端節點類型)輸入對應的 IP、域名或實例 ID。 | 120.XX.XX.21 |
SubAddress | string | 否 | 彈性網卡的私網 IP 地址。 說明
當終端節點類型為 ENI 時,可以選擇配置該參數,如果不配置默認為 ENI 的主私網 IP 地址。
| 172.168.XX.XX |
EndpointRequestProtocol | string | 否 | 后端服務協議。取值:
說明
| HTTP |
EndpointProtocolVersion | string | 否 | 后端服務協議版本。取值:
說明
僅當 EndpointRequestProtocol(后端服務協議)值為 HTTPS 時,支持配置終端節點后端服務協議版本。
| HTTP1.1 |
PortOverrides | array<object> | 否 | 端口映射關系。 | |
object | 否 | 端口映射關系。 | ||
ListenerPort | integer | 否 | 配置端口映射中的監聽端口。 說明
| 443 |
EndpointPort | integer | 否 | 配置端口映射中的終端節點端口。 | 80 |
HealthCheckEnabled | boolean | 否 | 是否開啟健康檢查。取值:
| true |
返回參數
示例
正常返回示例
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 | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-07-20 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-11-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-09-14 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-06-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |