接口功能介绍
创建后端服务
接口约束
该接口为异步接口,第一次请求会返回资源在创建中,需要用户发起多次请求,直到 status 为 done 为止。
由于是批量的接口,该接口目前也无法返回后端服务的 id。
当前接口使用前使用资源池概况信息查询接口查询待对接的资源池信息,如资源池概况信息查询结果为"regionVersion":"v3.0",即可使用;如资源池概况信息结果为"regionVersion":"v4.0",请使用API内接口创建后端服务。
URI
POST /v4/elb/async-create-vm
请求参数
请求Body参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
clientToken | String | 是 | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一 | test-token |
regionID | String | 是 | 区域ID | 81f7728662dd11ec810800155d307d5b |
targetGroupID | String | 是 | 后端服务组ID | xxxxxxxx |
targets | Array of Objects | 是 | 后端服务主机 | 见下表 |
表 targets
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
instanceID | String | 是 | 后端服务主机 id | xxxxxxxxxx |
protocolPort | Integer | 是 | 后端服务监听端口 | 80 |
instanceType | String | 后端服务主机类型,目前支持 vm | vm | |
weight | Integer | 是 | 后端服务主机权重: 1 - 256 | 1 |
address | String | 是 | 后端服务主机主网卡所在的 IP | 192.168.0.1 |
name | String | 是 | 后端服务名 | test |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 |
message | String | statusCode为900时的错误信息,英文 | success |
descritption | String | statusCode为800时的错误信息,中文 | |
errorCode | String | 错误明细 | SUCCESS |
returnObj | Object | 返回结果 | 见下表 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
status | String | 创建进度: in_progress / done | in_progress |
message | String | 进度说明 | 请使用相同请求,进行重试 |
请求示例
POST /v4/elb/async-create-target
请求体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": "请使用相同请求,进行重试"
}
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。