更新負載均衡監聽的屬性。
接口說明
UpdateListenerAttribute 接口屬于異步接口,即系統返回一個請求 ID,但該監聽的配置尚未更新成功,系統后臺的更新任務仍在進行。您可以調用 GetListenerAttribute 查詢監聽的配置的更新狀態:
- 當監聽器處于 Configuring 狀態時,表示監聽的配置正在更新中。
- 當監聽器處于 Running 狀態時,表示監聽的配置更新成功。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
gwlb:UpdateListenerAttribute | update |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ListenerId | string | 是 | 監聽 ID。 | lsn-lxce8iqbof2vl0**** |
ListenerDescription | string | 否 | 自定義監聽描述。 長度限制為 2~256 個字符,支持中文和英文字母,可包含數字、半角逗號(,)、半角句號(.)、半角分號(;)、正斜線(/)、at(@)、下劃線(_)和短劃線(-)。 | listener_description |
ServerGroupId | string | 否 | 服務器組 ID。 | sgp-sp8d2r6y7t0xtl**** |
DryRun | boolean | 否 | 是否只預檢此次請求。取值:
| false |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。說明 若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。 | 123e4567-e89b-12d3-a456-42665544**** |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "7DBFC67C-A272-5952-8287-6C3EBE4E04D9"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IncorrectBusinessStatus.LoadBalancer | The business status of %s [%s] is incorrect. | 資源%s業務狀態%s不支持當前操作 |
400 | IncorrectStatus.LoadBalancer | The status of %s [%s] is incorrect. | 資源%s當前狀態%s不支持操作 |
400 | IncorrectStatus.Listener | The status of %s [%s] is incorrect. | 資源%s當前狀態%s不支持操作。 |
400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | 兩個資源的VPC ID不匹配 |
400 | ResourceInUse.IP | The specified resource of IP is in use. | 指定的IP地址已被使用 |
400 | IncorrectStatus.ServerGroup | The status of %s [%s] is incorrect. | 資源%s當前狀態%s不支持操作 |
404 | ResourceNotFound.LoadBalancer | The specified resource of %s is not found. | 指定的負載均衡資源不存在 |
404 | ResourceNotFound.Listener | The specified resource of %s is not found. | 指定的監聽資源不存在 |
404 | ResourceNotFound.ServerGroup | The specified resource of %s is not found. | 指定的服務器組資源不存在。 |
訪問錯誤中心查看更多錯誤碼。