创建负载均衡接口
更新时间：2026-10-15
接口
本接口用于创建站点所属的负载均衡。
请求接口
| Method | Path | 说明 |
|---|---|---|
| POST | /v2/geo/load-balance | 创建负载均衡 |
请求体
| 字段名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| siteId | Int | 是 | 要创建的负载均衡的所属站点Id |
| name | String | 是 | 负载均衡名称，支持字符为‘a-z’，‘A-Z’，‘0-9’，‘_’，‘*’，‘-’，长度限制为200 |
| dispatchMode | String | 是 | 负载均衡策略，其合法值为：主备调度(优先级） “priority_mode” 或者加权轮询（权重） “weight_mode” |
| sessionMode | String | 是 | 会话保持，其合法值为：“IP”、“OFF” |
| detectConfig | Obeject<DetectConfig> | 是 | 健康探测配置 |
| originPoolIds | Array<String> | 是 | 负载均衡使用的源站池id数组。当负载均衡策略为主备调度时，源站池id顺序表示优先级顺序 |
| weights | Array<String> | 否 | 源站池权重。当负载均衡策略为加权轮询时，必传。需要按使用的源站池id顺序一一对应。 |
| fallbackOriginPoolId | String | 否 | 兜底源站池Id，不设置则不传 |
DetectConfig 类型说明
| 字段名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| healthCheckType | String | 否 | 健康探测类型，其合法值为：“ICMP”、“TCP”、“UDP”、“OFF”。选择 HTTPS/HTTP 类型时，该字段无需传参 |
| probeInterval | Int | 是 | 探测间隔，取值范围：10-3600，单位：秒 |
| probeMinSuccesses | Int | 是 | 健康阈值，探测最小成功阈值，取值范围1-5，需与探测最大失败阈值保持一致 |
| probeMaxFails | Int | 是 | 健康阈值，探测最大失败阈值，取值范围1-5，需与探测探测最小成功阈值保持一致 |
| probeTimeout | Int | 是 | 探测超时时间。单位：秒。其合法值为：3 |
| probeSucceedCode | String | 否 | 状态码，其合法值为：“1xx”、“2xx”、“3xx”、“4xx”、“5xx”。当健康探测类型为 HTTPS/HTTP 时必填 |
| probeUrl | String | 否 | 探测路径，当健康探测类型为 HTTPS/HTTP 时必填，例如：'/health/test.txt' |
| probeMethod | String | 否 | 探测请求方法，当健康探测类型为 HTTPS/HTTP 时必填。其合法值为“GET” |
| checkData | String | 否 | 探测请求内容。可填写500个长度以内的字符。当健康探测类型为 UDP 时必填 |
| checkResult | String | 否 | 探测返回结果。可填写500个长度以内的字符。未填写返回任意报文即认为探测成功。当健康探测类型为 UDP 时选填 |
## 响应码
| HTTP Status Code | 说明 |
|---|---|
| 200 | 创建成功 |
| 400 | 负载均衡创建请求参数无效 |
| 500 | 服务端错误 |
响应体
| 参数 | 类型 | 说明 |
|---|---|---|
| success | Bool | 创建负载均衡成功 |
请求示例1：主备调度
Plain Text
1POST /v2/geo/load-balance HTTP/1.1
2Host: geo.baidubce.com
3Authorization: xxx
4Content-Type: application/json;charset=utf-8
5Accept-Encoding: gzip
6{
7 "siteId":1,
8 "name":"test",
9 "dispatchMode": "priority_mode",
10 "sessionMode" : "IP",
11 "detectConfig" : {
12 "healthCheckType": "ICMP",
13 "probeInterval": 10,
14 "probeMinSuccesses": 5,
15 "probeMaxFails": 5,
16 "probeTimeout":3
17 },
18 "originPoolIds":[
19 "geo_fIyyiMbsYCtl",
20 "geo_BE4APhb3xOC7"
21 ],
22 "fallbackOriginPoolId":"geo_fIyyiMbsYCtl"
23}请求示例2：加权轮询调度
Plain Text
1POST /v2/geo/load-balance HTTP/1.1
2Host: geo.baidubce.com
3Authorization: xxx
4Content-Type: application/json;charset=utf-8
5Accept-Encoding: gzip
6{
7 "siteId":1,
8 "name":"test",
9 "dispatchMode": "weight_mode",
10 "sessionMode" : "OFF",
11 "detectConfig" : {
12 "probeInterval" : 60
13 "probeMaxFails" : 1
14 "probeMethod" : "GET"
15 "probeMinSuccesses" : 1
16 "probeSucceedCode" : "2xx"
17 "probeTimeout" : 3
18 "probeUrl" : "/"
19 },
20 "originPoolIds":[
21 "geo_fIyyiMbsYCtl",
22 "geo_BE4APhb3xOC7"
23 ],
24 "weights":[
25 10,
26 20
27 ],
28 "fallbackOriginPoolId":"geo_fIyyiMbsYCtl"
29}响应示例
Plain Text
1HTTP/1.1 200 OK
2Server: nginx/1.16.1
3Content-Type: application/json; charset=utf-8
4Transfer-Encoding: chunked
5Connection: keep-alive
6{
7 "success": true
8}评价此篇文章