調用UpdateListener接口修改全球加速實例下指定監聽的配置。
接口說明
本接口用于修改指定監聽的協議、端口等信息,使監聽配置滿足您的業務需求。
在調用本接口時,請注意以下事項:
- UpdateListener 接口屬于異步接口,即系統會先返回一個請求 ID,但監聽配置并未修改完成,系統后臺的修改任務仍在進行。您可以調用 DescribeListener 查詢監聽的狀態:
- 當監聽處于 updating 狀態時,表示監聽配置正在修改中,在該狀態下,您只能執行查詢操作,不能執行其他操作。
- 當監聽處于 active 狀態時,表示監聽配置修改完成。
- UpdateListener 接口不支持在同一個全球加速實例內并發修改監聽配置。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ga:UpdateListener | update |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 全球加速實例所在的地域 ID,僅取值cn-hangzhou。 | cn-hangzhou |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
Name | string | 否 | 監聽的名稱。 名稱長度為 1~128 個字符,以大小寫字母或中文開頭,可包含數字、半角句號(.)下劃線(_)和短劃線(-)。 | Listener |
Description | string | 否 | 監聽的描述信息。 描述長度最大為 200 個字符,不能以 | Listener |
ClientAffinity | string | 否 | 客戶端親和性。取值:
| SOURCE_IP |
Protocol | string | 否 | 監聽的網絡傳輸協議類型,取值:
| tcp |
ListenerId | string | 是 | 監聽實例 ID。 | lsr-bp1bpn0kn908w4nbw**** |
ProxyProtocol | string | 否 | 是否開啟保持客戶端源 IP 功能。
說明
該參數后續將不在監聽 API 中配置,建議在終端節點組的相關 API 中進行配置。關于 ProxyProtocol,請參見 CreateEndpointGroup 和 UpdateEndpointGroup 。
| false |
PortRanges | array<object> | 否 | ||
object | 否 | |||
FromPort | integer | 是 | 用來接收請求并向終端節點進行轉發的起始監聽端口。 可配置的監聽端口范圍為 1~65499,且需滿足 FromPort≤ToPort。 最多可配置端口數量與監聽路由類型和監聽協議類型相關,更多信息,請參見監聽端口。 說明
對于 HTTP 或 HTTPS 協議的監聽,只支持配置一個監聽端口,即起始監聽端口和結束監聽端口需相同。
| 20 |
ToPort | integer | 是 | 用來接收請求并向終端節點進行轉發的結束監聽端口。 可配置的監聽端口范圍為 1~65499,且需滿足 FromPort≤ToPort。 最多可配置端口數量與監聽路由類型和監聽協議類型相關,更多信息,請參見監聽端口。 說明
對于 HTTP 或 HTTPS 協議的監聽,只支持配置一個監聽端口,即起始監聽端口和結束監聽端口需相同。
| 21 |
Certificates | array<object> | 否 | SSL 證書。 | |
object | 否 | SSL 證書。 | ||
Id | string | 否 | SSL 證書 ID。 說明
僅 HTTPS 協議的監聽需要配置該項。
| 449****-cn-hangzhou |
BackendPorts | array<object> | 否 | 后端服務器接收請求的端口范圍。 | |
object | 否 | 后端服務器接收請求的端口范圍。 | ||
FromPort | integer | 否 | 后端服務器接收請求的起始端口。 說明
當您的監聽協議為 HTTP 或 HTTPS,且監聽的端口和后端服務器提供服務的端口不一致時才需填寫該項。其中,后端服務器接收請求的起始端口和結束端口需相同。
| 80 |
ToPort | integer | 否 | 后端服務器接收請求的結束端口。 說明
當您的監聽協議為 HTTP 或 HTTPS,且監聽的端口和后端服務器提供服務的端口不一致時才需填寫該項。其中,后端服務器接收請求的起始端口和結束端口需相同。
| 80 |
XForwardedForConfig | object | 否 |
| |
XForwardedForGaIdEnabled | boolean | 否 | 是否通過
說明
僅 HTTP 和 HTTPS 監聽支持此參數。
| false |
XForwardedForProtoEnabled | boolean | 否 | 是否通過
說明
僅 HTTP 和 HTTPS 監聽支持此參數。
| false |
XForwardedForPortEnabled | boolean | 否 | 是否通過
說明
僅 HTTP 和 HTTPS 監聽支持此參數。
| false |
XRealIpEnabled | boolean | 否 | 是否通過
說明
僅 HTTP 和 HTTPS 監聽支持此參數。
| false |
XForwardedForGaApEnabled | boolean | 否 | 是否通過
說明
僅 HTTP 和 HTTPS 監聽支持此參數。
| false |
SecurityPolicyId | string | 否 | 安全策略實例 ID。取值:
說明
僅 HTTPS 監聽支持此參數。
| tls_cipher_policy_1_0 |
IdleTimeout | integer | 否 | 連接空閑超時時間。單位:秒。
| 900 |
RequestTimeout | integer | 否 | HTTP/HTTPS 的連接請求超時時間。單位:秒。 可選:1-180s,默認 60s。 說明
僅對 Protocol(網絡傳輸協議類型)為 HTTP 或 HTTPS 的監聽有效。如果在超時時間內后端服務器一直沒有響應,全球加速將放棄等待,并給客戶端返回 HTTP 504 錯誤碼。
| 60 |
HttpVersion | string | 否 | HTTP 協議的最大版本,取值:
說明
僅 HTTPS 監聽支持此參數。
| http2 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | NotActive.Listener | The state of the listener is not active. | 監聽器狀態非穩態 |
400 | PortRangeIllegal.Listener | The specified listener port range is invalid. | 監聽端口范圍配置非法 |
400 | PortConflict.Listener | The listener port configuration is in conflict. | 監聽端口配置沖突 |
400 | QuotaExceeded.ListenerPort | The maximum number of listener ports is exceeded. | 監聽端口達到Quota限制 |
400 | NotExist.Accelerator | The accelerated instance does not exist. | 加速實例不存在。 |
400 | StateError.Accelerator | The state of the accelerated instance is invalid. | 加速實例狀態非法。 |
400 | Exist.PortOverride | Port override exists. | 端口映射已存在。 |
400 | RegionNotSupportHugePort.Listener | The current ipSet or listener region does not support hugePort. | - |
400 | PortRanges.MustOne | The portRanges must be one for HTTPS and HTTP type listener. | HTTPS/HTTP類型監聽只支持一個端口 |
400 | SecurityPolicyIdIllegal.Listener | The listener security policy ID %s is illegal. | 監聽安全策略ID不合法。 |
400 | SecurityPolicyId.NotNeed | No security policy ID is required for the listener. | 當前監聽不需要配置安全策略ID。 |
403 | Forbbiden.SubUser | You are not authorized to operate on the specified resource because your account was created by another user. | 該賬號為其他賬號的子賬號,沒有操作特定資源的權限。 |
403 | Forbidden | The user is not authorized to operate on the specified resource. | 該賬號沒有操作特定資源的權限。 |
500 | UnknownError | An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. | 處理請求時出現錯誤,請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-03-27 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-11-06 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |