異步創建后端主機
更新時間 2025-05-23 22:34:45
最近更新時間: 2025-05-23 22:34:45
分享文章
接口功能介紹
創建后端服務
接口約束
該接口為異步接口，第一次請求會返回資源在創建中，需要用戶發起多次請求，直到 status 為 done 為止。由于是批量的接口，該接口目前也無法返回后端服務的 id。
URI
POST /v4/elb/async-create-vm
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客戶端存根，用于保證訂單冪等性, 長度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 | |
| regionID | 是 | String | 區域ID | 81f7728662dd11ec810800155d307d5b | |
| targetGroupID | 是 | String | 后端服務組ID | xxxxxxxx | |
| targets | 是 | Array of Objects | 后端服務主機 | 見下表 | targets |
表 targets
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| instanceID | 是 | String | 后端服務主機 id | xxxxxxxxxx | |
| protocolPort | 是 | Integer | 后端服務監聽端口，1-65535 | 80 | |
| instanceType | 是 | String | 后端服務主機類型，僅支持vm類型 | vm | |
| weight | 是 | Integer | 后端服務主機權重: 1 - 256 | 1 | |
| address | 是 | String | 后端服務主機主網卡所在的 IP | 192.168.0.1 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗） | 800 | |
| message | String | statusCode為900時的錯誤信息; statusCode為800時為success, 英文 | success | |
| description | String | statusCode為900時的錯誤信息; statusCode為800時為成功, 中文 | 成功 | |
| errorCode | String | statusCode為900時為業務細分錯誤碼，三段式：product.module.code; statusCode為800時為SUCCESS | SUCCESS | |
| returnObj | Object | 返回結果 | 見下表 | |
| error | String | statusCode為900時為業務細分錯誤碼，三段式：product.module.code; statusCode為800時為SUCCESS |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| status | String | 創建進度: in_progress / done | in_progress | |
| message | String | 進度說明 | 請使用相同請求，進行重試 |
枚舉參數
無
請求示例
請求url
POST /v4/elb/async-create-vm
請求頭header
無
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"targetGroupID": "tg-71mh1rkfpn",
"clientToken": "qlrsiEQSDUgkXRoFTH181AxWJ8UXGYY4a72rdDlnkRhHrj4IP3jze8U4Vd5fxJot",
"targets": [
{
"instanceID": "Xxxxxx",
"address": "192.168.0.1",
"weight": 100,
"protocolPort": 80
}
]
}
響應示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"status": "in_progress",
"message": "請使用相同請求，進行重試"
}
}
狀態碼
請參考
錯誤碼
請參考
