接口功能介绍
创建负载均衡实例,该接口为异步接口,第一次请求会返回资源在创建中,需要用户发起多次请求,直到 status 为 done 为止。
接口约束
当前接口使用前使用资源池概况信息查询接口查询待对接的资源池信息,如资源池概况信息查询结果为"regionVersion":"v3.0",即可使用;如资源池概况信息结果为"regionVersion":"v4.0",请使用API内接口创建负载均衡实例。
URI
POST /v4/elb/async-create-loadbalance
请求参数
请求Body参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
clientToken | String | 是 | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一 | |
regionID | String | 是 | 区域ID | |
vpcID | String | 是 | vpc的ID | |
subnetID | String | 是 | 子网的ID | |
name | String | 是 | 名称 | |
description | String | 否 | 描述 | |
eipID | String | 否 | 弹性公网IP的ID。当resourceType=external为必填 | |
resourceType | String | 是 | 资源类型。internal:内网负载均衡,external:公网负载均衡 | |
privateIpAddress | String | 否 | 负载均衡的私有IP地址,不指定则自动分配 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
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 | 进度说明 | 请使用相同请求,进行重试 |
loadBalanceID | String | 负载均衡ID,可能为 null | edbe1a3e-bac3-48a5-9357-d9239d7d1577 |
请求示例
POST /v4/elb/async-create-loadbalance
请求体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
}
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。