1)接口功能介绍
创建负载均衡。
2)接口约束
需要正确的边缘池id,可通过查看区域集群编码列表接口获取。
3)URI
POST /v1/createLoadBalancer。
4)请求参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘池id,可通过查看区域集群编码列表接口获取 | cn-guangzhou6 | |
name | 是 | String | 负载均衡器名称。建议格式为:slb-***。命名要求:小写字母、数字或中划线(-)组成;小写字母开头;数字或小写字母结尾;长度不超过64。 | slb-042a3d | |
type | 是 | String | 负载均衡器类型.EXTERNAL-外网SLB,INTERNAL-内网SLB | EXTERNAL | |
vpcId | 是 | String | 虚拟私有云ID。负载均衡器所在VPC,通过查看vpc列表信息(describeVpc)接口获取 | 231 | |
eipId | 否 | String | 弹性公网IP id。负载均衡器类型为EXTERNAL时,该字段生效,若eipId不为空,则绑定对应的ip,否则不生效 | 3453 | |
description | 否 | String | 负载均衡器描述。最大不超过255个字符 | sdk-test |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
slbId | 是 | String | 转发策略ID | 22 |
6)请求示例
请求体body
{
"nodeCode": "cn-guangzhou-2",
"name": "slb-test",
"vpcId": "12",
"description": "test",
"type": "INTERNAL"
}
7)响应示例
{
"requestId": "525e58d1-073e-4b02-ae6c-12cf74c1e36d",
"status": {
"code": "Success",
"message": "Success"
},
"data": {
"slbId": "345"
}
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |