向服務器組中添加后端服務器。
接口說明
AddServersToServerGroup 接口屬于異步接口,即系統返回一個請求 ID,但該后端服務器尚未添加成功,系統后臺的添加任務仍在進行。
- 您可以調用 ListServerGroups 查詢服務器組的狀態:
- 當服務器組處于 Configuring 狀態時,表示服務器組正在變配中。
- 當服務器組處于 Available 狀態時,表示服務器組運行中。
- 您可以調用 ListServerGroupServers 查詢后端服務器的狀態:
- 當后端服務器處于 Adding 狀態時,表示后端服務器正在加入服務器組。
- 當后端服務器處于 Available 狀態時,表示后端服務器運行中。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
alb:AddServersToServerGroup | Write |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ServerGroupId | string | 是 | 服務器組 ID。 | sgp-atstuj3rtop**** |
Servers | array<object> | 是 | 后端服務器列表, 單次調用最多支持添加 200 個服務器。 | |
object | 是 | 后端服務器組結構體。 | ||
Description | string | 否 | 后端服務器描述。長度為 2~256 個英文或中文字符,不能以 http://和 https://開頭。 | test |
Port | integer | 否 | 后端服務器使用的端口。取值范圍:1~65535。 單次調用最多支持添加 200 個服務器。 說明
當 ServerType 取值為 Ecs、Eni、Eci、Ip 時,該參數必傳。當 ServerType 取值為 Fc 時,無需配置該參數。
| 80 |
ServerId | string | 是 | 后端服務器 ID。 單次調用最多支持添加 200 個服務器。
| i-uf616vu8me****** |
ServerIp | string | 否 | 指定 IP 地址。 單次調用最多支持添加 200 個服務器。 說明
ServerType 取值為 Fc 時,無需配置該參數。
| 192.168.1.1 |
ServerType | string | 是 | 后端服務器類型。 單次調用最多支持添加 200 個服務器。取值:
| Ecs |
Weight | integer | 否 | 后端服務器的權重,取值范圍:0~100。默認值為 100。如果設置權重為 0,則不會將請求轉發給該后端服務器。 單次調用最多支持添加 200 個服務器。 說明
ServerType 取值為 Fc 時,無需配置該參數。
| 100 |
RemoteIpEnabled | boolean | 否 | 是否開啟遠端 IP 功能。 單次調用最多支持添加 200 個服務器。取值:
說明
當 ServerType 取值為 Ip 時,該參數有效。
| false |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 593B0448-D13E-4C56-AC0D-FDF0****** |
DryRun | boolean | 否 | 是否只預檢此次請求,取值:
| false |
返回參數
示例
正常返回示例
JSON
格式
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF34******"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ResourceQuotaExceeded.ServerAddedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 配額%s已超額度限制,資源是%s,目前已使用%s,配額為%s。 |
400 | IncorrectStatus.ServerGroup | The status of %s [%s] is incorrect. | 服務器組狀態無效。 |
400 | Conflict.BackendServer | There is already %s having the same configuration with %s. | %s沖突,已經存在同配置的%s。 |
400 | OperationDenied.VpcVportNotFound | The operation is not allowed because of %s. | 不允許該操作,原因:vpc端口未找到 |
400 | IncorrectStatus.Eni | The status of %s [%s] is incorrect. | 資源%s [%s]的狀態無效。 |
400 | ResourceInUse.IP | The specified resource %s is in use. | 資源%s正在使用中。 |
400 | OperationDenied.NoAvailableVSwitch | The operation is not allowed because of %s. | 操作被拒絕,原因是%s。 |
400 | OperationDenied.VgwVipNotFound | The operation is not allowed because of %s. | 操作被拒絕,原因是%s。 |
400 | OperationDenied.CloudBox | The operation is not allowed because of %s. | 操作被拒絕,原因是%s。 |
400 | Mismatch.Type | The %s is mismatched for %s and %s. | %s在%s和%s中不匹配。 |
400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | %s在%s和%s中不匹配。 |
400 | ResourceQuotaExceeded.LoadBalancerServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 配額%s已超額度限制,資源是%s,目前已使用%s,配額為%s。 |
400 | ResourceInConfiguring | The specified resource of %s is being configured. Please try again later. | 指定的資源在變更中,請稍后再試 |
400 | DuplicatedParam.BackendServer | The param of %s is duplicated. | 參數%s是重復的。 |
400 | OperationDenied.EciNotSupportJobType | The operation is not allowed because of eci not support job type. | 服務器組不支持添加Job優化型ECI實例。 |
400 | IllegalParam.ServerIp | The param of ServerIp is illegal. | 參數ServerIp非法 |
400 | Mismatch.ServerType | The %s is mismatched for %s and %s. | %s在%s和%s中不匹配。 |
400 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 請求因服務器暫時性故障而失敗。 |
403 | Forbidden.ServerGroup | Authentication has failed for ServerGroup. | 對ServerGroup鑒權失敗 |
404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. | 資源%s不存在。 |
404 | ResourceNotFound.Ecs | The specified resource %s is not found. | 資源%s不存在。 |
404 | ResourceNotFound.Eci | The specified resource %s is not found. | 資源%s不存在。 |
404 | ResourceNotFound.Eni | The specified resource %s is not found. | 資源%s不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-01-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-24 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-24 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-07-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |