接口功能介绍
创建负载均衡实例,该接口为异步接口,第一次请求会返回资源在创建中,需要用户发起多次请求,直到 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
}
}
状态码
请参考 状态码
错误码
请参考 错误码