更新負載均衡實例屬性,如名稱、修改保護等。
接口說明
UpdateLoadBalancerAttribute 接口屬于異步接口,即系統返回一個請求 ID,但該應用型負載均衡實例屬性尚未修改成功,系統后臺的修改任務仍在進行。您可以調用 GetLoadBalancerAttribute 查詢應用型負載均衡實例屬性的修改狀態:
- 當應用型負載均衡實例屬性處于 Configuring 狀態時,表示應用型負載均衡實例屬性正在修改中。
- 當應用型負載均衡實例屬性處于 Active 狀態時,表示應用型負載均衡實例屬性修改成功。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
alb:UpdateLoadBalancerAttribute | Write |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
DryRun | boolean | 否 | 是否只預檢此次請求,取值:
| true |
LoadBalancerId | string | 是 | 應用型負載均衡實例 ID。 | alb-o9ulmq5hgn68jk**** |
LoadBalancerName | string | 否 | 應用型負載均衡實例的名稱,長度為 2~128 個英文或中文字符,必須以大小寫字母或中文開頭,可包含數字、半角句號(.)、下劃線(_)和短劃線(-)。 | alb-instance-test |
ModificationProtectionConfig | object | 否 | 修改保護配置。 | |
Reason | string | 否 | 長度為 2~128 個英文或中文字符,必須以大小寫字母或中文開頭,可包含數字、半角句號(.)、下劃線(_)和短劃線(-)。 僅在 ModificationProtectionStatus 為 ConsoleProtection 有效且合法。 | 托管實例 |
Status | string | 否 | 應用型負載均衡修改保護狀態。取值:
說明
當取值為 ConsoleProtection,即開啟修改保護后,用戶不能通過負載均衡控制臺修改實例配置,但可以通過調用 API 修改實例配置。
| ConsoleProtection |
返回參數
示例
正常返回示例
JSON
格式
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IncorrectStatus.LoadBalancer | The status of %s [%s] is incorrect. | 資源%s [%s]的狀態無效。 |
400 | IncorrectBusinessStatus.LoadBalancer | The business status of %s [%s] is incorrect. | 資源%s [%s]的業務狀態無效。 |
403 | Forbidden.LoadBalancer | Authentication is failed for %s. | 負載均衡操作鑒權失敗。 |
404 | ResourceNotFound.LoadBalancer | The specified resource %s is not found. | 資源%s不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2024-01-29 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
|