接口功能介绍
创建后端服务
接口约束
该接口为异步接口，第一次请求会返回资源在创建中，需要用户发起多次请求，直到 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": "请使用相同请求，进行重试"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
