向網絡型負載均衡服務器組中添加后端服務器。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| nlb:AddServersToServerGroup | Write |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ServerGroupId | string | 是 | 服務器組 ID。 | sgp-atstuj3rtoptyui**** |
| Servers | object [] | 是 | 后端服務器列表。 說明
單次調用最多支持傳入 200 個服務器。
| |
| ServerId | string | 是 | 后端服務器 ID。
| i-bp67acfmxazb4p**** |
| ServerType | string | 是 | 后端服務器類型，取值：
| Ecs |
| ServerIp | string | 否 | 服務器 IP 地址。當服務器組為 Ip 類型時，必須指定 IP 地址。 | 192.168.6.6 |
| Port | integer | 否 | 后端服務器使用的端口。端口范圍0~65535，不填則默認傳入端口值 0。 當服務器組開啟全端口轉發后，添加后端服務器時無需指定端口（默認傳入 0），NLB 將按照前端請求端口轉發流量至后端服務器。您可以通過 ListServerGroups 接口返回的 AnyPortEnabled 字段查詢是否開啟了全端口轉發。 | 443 |
| Weight | integer | 否 | 后端服務器的權重，取值范圍：0~100。默認值為 100。如果設置權重為 0，則不會將請求轉發給該后端服務器。 | 100 |
| Description | string | 否 | 服務器描述信息。 長度限制為 2-256 個字符，可包含英文字母、數字、中文、半角逗號（,）、半角句號（.）、半角分號（;）、正斜線（/）、at（@）、下劃線（_）和短劃線（-）。 | ECS |
| RegionId | string | 否 | 網絡型負載均衡實例所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| DryRun | boolean | 否 | 是否只預檢此次請求。取值：
| false |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
"ServerGroupId": "sgp-atstuj3rtoptyui****",
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | Conflict.Lock | The Lock [%s] is conflict. | 指定的資源當前存在鎖沖突。 |
| 400 | IllegalParam.IP | The param of IP is illegal. | 參數IP非法。請檢查參數IP的輸入值。 |
| 400 | QuotaExceeded.QuotaInsufficient | The quota of %s is exceeded, usage %s/%s. | 配額不足，已使用%s/%s。請在配額中心中修改配額大小。 |
| 400 | SystemBusy | System is busy, please try again later. | 系統繁忙，請稍后重試 |
| 400 | DuplicatedParam.Server | The param of Server is duplicated. | 參數中的server重復了。 |
| 400 | IncorrectStatus.serverGroup | The status of servergroup [%s] is incorrect. | 服務器組的狀態無法進行當前操作，請檢查服務器組當前是否處于其他操作下。 |
| 400 | Mismatch.VpcId | The VpcId is mismatched for %s and %s. | 資源%s和資源%s的VpcId不匹配。請檢查兩種資源是否在同一個VPC下。 |
| 400 | Mismatch.ServerType | The ServerType is mismatched for %s and %s. | ServerType不匹配 |
| 400 | IllegalParam.RSPortConflictWithServerGroup | The param of RSPortConflictWithServerGroup is illegal. | 參數RSPort與ServerGroup沖突。請檢查輸入值。 |
| 400 | TagInvokeError | listTagsByResourceIds: InvalidResourceId.NotFound : The specified ResourceIds are not found in our records. | 在資源標簽中找不到資源定義，請檢查RAM是否給NLB添加授權。 |
| 400 | ResourceInUse.IP | The specified resource of IP is in use. | 傳入的IP不能是NLB的eni地址，請檢查參數。 |
| 400 | IllegalParam | The param of %s is illegal. | 輸入的參數有值非法，請檢查輸入。 |
| 400 | MissingParam.%s | The parameter of %s is missing. | 參數%s缺失，請檢查輸入參數。 |
| 400 | IllegalParam.description | The parameter description of server is illegal. | 服務器描述不符合輸入要求，請根據錯誤中的詳細信息進行修改。 |
| 400 | MissingParam.IP | The param of IP is missing. | 輸入的IP參數缺失，請檢查您的輸入參數。 |
| 400 | OperationDenied.ServerGroupNotSupportIpv6 | The operation is not allowed because of ServerGroupNotSupportIpv6. | 因為服務器組不支持IPV6，所以操作失敗。 |
| 400 | IncorrectStatus.Eni | Eni status is invalid. | 彈性網卡狀態不合法。 |
| 400 | IdempotenceSignatureMismatch | The idempotence token of request is same with the prev one, but the signature is different. | 請求的冪等令牌與上一個相同，但簽名不同。 |
| 400 | Throttling.User | Request was denied due to api flow control. | 由于觸發流控，請求被拒絕。 |
| 403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因為賬號沒有權限，所以鑒權失敗。 |
| 404 | ResourceNotFound.serverGroup | The specified resource of serverGroup is not found. | 找不到指定的服務器組資源，請檢查輸入參數。 |
| 404 | ResourceNotFound.Eci | The specified resource of Eci is not found. | 找不到指定的彈性容器實例(Eci)資源，請檢查輸入的參數。 |
| 404 | ResourceNotFound.Ecs | The specified resource of Ecs is not found. | 找不到指定的ECS資源， 請檢查輸入的參數。 |
| 404 | ResourceNotFound.Eni | The specified resource Eni is not found. | 沒有找到指定的彈性網卡實例，請檢查輸入參數。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2024-04-02 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2024-01-29 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2024-01-24 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2024-01-22 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-10-30 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-10-07 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-09-26 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-09-13 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-09-05 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-08-22 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-08-22 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
|