異步創建負載均衡
更新時間 2025-05-23 22:34:53
最近更新時間: 2025-05-23 22:34:53
分享文章
接口功能介紹
創建負載均衡實例，該接口為異步接口，第一次請求會返回資源在創建中，需要用戶發起多次請求，直到 status 為 done 為止。
接口約束
無
URI
POST /v4/elb/async-create-loadbalance
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客戶端存根，用于保證訂單冪等性, 長度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 | |
| regionID | 是 | String | 區域ID | ||
| vpcID | 否 | String | vpc的ID | ||
| subnetID | 是 | String | 子網的ID | ||
| name | 是 | String | 唯一。支持拉丁字母、中文、數字，下劃線，連字符，中文 / 英文字母開頭，不能以 http: / https: 開頭，長度 2 - 32 | acl11 | |
| description | 否 | String | 支持拉丁字母、中文、數字, 特殊字符： |
《》？：“”【】、；‘'，。、，不能以 http: / https: 開頭，長度 0 - 128 | acl |
| eipID | 否 | String | 彈性公網IP的ID。當resourceType=external為必填 | ||
| resourceType | 是 | String | 資源類型。internal：內網負載均衡，external：公網負載均衡 | ||
| privateIpAddress | 否 | String | 負載均衡的私有IP地址，不指定則自動分配 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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 | 返回結果 | 見下表 | returnObj |
| error | String | statusCode為900時為業務細分錯誤碼，三段式：product.module.code; statusCode為800時為SUCCESS |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| status | String | 創建進度: in_progress / done | in_progress | |
| message | String | 進度說明 | 請使用相同請求，進行重試 | |
| loadBalanceID | String | 負載均衡ID，可能為 null | edbe1a3e-bac3-48a5-9357-d9239d7d1577 |
枚舉參數
無
請求示例
請求url
POST /v4/elb/async-create-loadbalance
請求頭header
無
請求體body
{
"clientToken": "xxxx",
"regionID": "81f7728662dd11ec810800155d307d5b",
"subnetID": "subnet-23k8nuci7z",
"name": "yacos_lb_test_ipv6",
"description": "yacos_lb_test_ipv6",
"resourceType": "internal",
"privateIpAddress": "10.10.0.10"
}
響應示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"status": "in_progress",
"message": "請使用相同請求，進行重試",
"loadBalanceID": null
}
}
狀態碼
請參考
錯誤碼
請參考
