為網絡型負載均衡實例綁定已創建的安全組。
接口說明
- 請確保您已創建安全組。創建安全組，請參見 CreateSecurityGroup 。
- 一個網絡型負載均衡實例最多支持加入 4 個安全組。
- 您可以通過 GetLoadBalancerAttribute 接口查詢實例綁定的安全組。
- LoadBalancerJoinSecurityGroup 屬于異步接口，即系統返回一個請求 ID，但該網絡型負載均衡實例綁定安全組尚未成功，系統后臺的綁定任務仍在進行。您可以調用 GetJobStatus 查詢安全組的綁定狀態：
- 當任務狀態處于 Succeeded 時，表示安全組綁定成功。
- 當任務狀態處于 Processing 時，表示安全組正在綁定中，在該狀態下，您只能執行查詢操作，不能執行其他操作。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| nlb:LoadBalancerJoinSecurityGroup | Write |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SecurityGroupIds | array | 是 | 安全組 ID。 | |
| string | 是 | 安全組 ID。 | sg-bp1fg655nh68xyz9**** | |
| LoadBalancerId | string | 是 | 待綁定安全組的網絡型負載均衡實例 ID。 | nlb-83ckzc8d4xlp8o**** |
| DryRun | boolean | 否 | 是否只預檢此次請求。取值：
| true |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
| RegionId | string | 否 | 網絡型負載均衡實例所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | SystemBusy | System is busy, please try again later. | 系統繁忙，請稍后重試 |
| 400 | QuotaExceeded.QuotaInsufficient | The quota of %s is exceeded, usage %s/%s. | 配額不足，已使用%s/%s。請在配額中心中修改配額大小。 |
| 400 | Conflict.SecurityGroup | The SecurityGroup [%s] is conflict. | 指定的資源當前存在鎖沖突。 |
| 400 | Mismatch.%s | The %s is mismatched for %s and %s. | 對于資源對象%s和%s，參數%s缺失 |
| 400 | OperationDenied.%s | The operation is not allowed because of %s. | 因為%s，當前操作是不允許的 |
| 400 | TagInvokeError | listTagsByResourceIds: InvalidResourceId.NotFound : The specified ResourceIds are not found in our records. | 在資源標簽中找不到資源定義，請檢查RAM是否給NLB添加授權。 |
| 400 | Conflict.Lock | The Lock [%s] is conflict. | 指定的資源當前存在鎖沖突。 |
| 400 | Mismatch.vpc | The Vpc is mismatched for %s and %s. | 資源%s和資源%s的VPC不匹配。請檢查兩種資源是否在同一個VPC下。 |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | dryRun請求驗證已通過。 |
| 400 | ResourceInCreating.loadbalancer | The specified resource of loadbalancer is creating, please try again later. | 正在創建指定的負載均衡器資源，請稍后重試。 |
| 400 | ResourceInConfiguring.loadbalancer | The specified resource of loadbalancer is being configured, please try again later. | 正在配置指定的負載均衡資源，請稍后重試。 |
| 403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因為賬號沒有權限，所以鑒權失敗。 |
| 403 | Forbidden.SecurityGroup | Authentication is failed for SecurityGroup. | 因為安全組沒有權限，所以鑒權失敗。 |
| 404 | ResourceNotFound.loadBalancer | The specified resource of loadbalancer is not found. | 找不到指定的負載均衡器資源，請檢查輸入參數。 |
| 404 | ResourceNotFound.SecurityGroup | The specified resource of SecurityGroup is not found. | 找不到指定的安全組資源，請檢查輸入參數。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-10-30 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-10-12 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-09-12 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-09-05 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-08-22 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
|