向負(fù)載均衡服務(wù)器組中添加后端服務(wù)器。
接口說明
AddServersToServerGroup 接口屬于異步接口,即系統(tǒng)返回一個請求 ID,但該后端服務(wù)器尚未添加成功,系統(tǒng)后臺的添加任務(wù)仍在進(jìn)行。
- 您可以調(diào)用 ListServerGroups 查詢服務(wù)器組的狀態(tài):
- 當(dāng)服務(wù)器組處于 Configuring 狀態(tài)時,表示服務(wù)器組正在變配中。
- 當(dāng)服務(wù)器組處于 Available 狀態(tài)時,表示服務(wù)器組運(yùn)行中。
- 您可以調(diào)用 ListServerGroupServers 查詢后端服務(wù)器的狀態(tài):
- 當(dāng)后端服務(wù)器處于 Adding 狀態(tài)時,表示后端服務(wù)器正在加入服務(wù)器組。
- 當(dāng)后端服務(wù)器處于 Available 狀態(tài)時,表示后端服務(wù)器運(yùn)行中。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
gwlb:AddServersToServerGroup | create |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ServerGroupId | string | 是 | 服務(wù)器組 ID。 | sgp-atstuj3rtoptyui**** |
Servers | array<object> | 是 | 后端服務(wù)器列表。 說明
單次調(diào)用最多支持傳入 200 個服務(wù)器。
| |
Server | object | 是 | 后端服務(wù)器。 | |
Port | integer | 否 | 后端服務(wù)器使用的端口,取值:
| 6081 |
ServerId | string | 是 | 后端服務(wù)器 ID。
| i-bp67acfmxazb4p**** |
ServerIp | string | 否 | 后端服務(wù)器 IP 地址。 | 192.168.XX.XX |
ServerType | string | 是 | 后端服務(wù)器類型,取值:
| Ecs |
DryRun | boolean | 否 | 是否只預(yù)檢此次請求,取值:
| false |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數(shù)值,確保不同請求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統(tǒng)自動使用 API 請求的 RequestId 作為 ClientToken 標(biāo)識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-42665544**** |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | Conflict.Server | The %s [%s] is conflict. | %s沖突,已經(jīng)存在同配置的%s。 |
400 | Mismatch.ServerType | The %s is mismatched for %s and %s. | ServerType不匹配。 |
400 | ResourceInUse.IP | The specified resource of %s is in use. | 指定的IP地址已被使用 |
400 | IllegalParam.ServerIp | The param of %s is illegal. | 參數(shù)ServerIp非法,請檢查輸入?yún)?shù)。 |
400 | IllegalParam.EcsNetworkType | The param of %s is illegal. | 參數(shù)EcsNetworkType非法,請檢查輸入?yún)?shù)。 |
400 | DuplicatedParam.Server | The param of %s is duplicated. | 參數(shù)中存在重復(fù)的server。 |
400 | ResourceInUse.Eni | The specified resource of %s is in use. | 傳入的eni不能是網(wǎng)關(guān)型負(fù)載均衡實(shí)例使用的eni,請檢查參數(shù)。 |
400 | IncorrectStatus.Eni | The status of %s [%s] is incorrect. | 資源%s當(dāng)前狀態(tài)%s不支持操作 |
400 | IllegalParam.IP | The param of %s is illegal. | 參數(shù)IP非法。請檢查參數(shù)IP的輸入值。 |
400 | Mismatch.IP | The %s is mismatched for %s and %s. | 輸入的IP類型服務(wù)器的ID和IP不匹配。 |
400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | 兩個資源的VPC ID不匹配 |
400 | QuotaExceeded.ServerGroupServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 配額gwlb_quota_servergroup_servers_num已超額度限制。 |
400 | QuotaExceeded.ServerGroupAzServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 配額gwlb_quota_servergroup_az_servers_num已超額度限制。 |
400 | IncorrectStatus.ServerGroup | The status of %s [%s] is incorrect. | 資源%s當(dāng)前狀態(tài)%s不支持操作 |
404 | ResourceNotFound.Eni | The specified resource of %s is not found. | 指定的彈性網(wǎng)卡資源不存在。 |
404 | ResourceNotFound.Eci | The specified resource of %s is not found. | 指定的彈性容器實(shí)例資源不存在。 |
404 | ResourceNotFound.ServerGroup | The specified resource of %s is not found. | 指定的服務(wù)器組資源不存在。 |
404 | ResourceNotFound.Ecs | The specified resource of %s is not found. | 指定的云服務(wù)器資源不存在。 |
訪問錯誤中心查看更多錯誤碼。