查询负载均衡接口
更新时间：2026-10-15
接口
本接口用于查询站点所属的负载均衡。
请求接口
| Method | Path | 说明 |
|---|---|---|
| GET | /v2/geo/load-balance | 查询负载均衡 |
请求参数
| 字段名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| siteId | Int | 是 | 要查询的负载均衡的所属站点Id |
| name | String | 否 | 负载均衡名称 |
| id | String | 否 | 负载均衡Id |
| fetchAll | Bool | 否 | 全量查询标识。设置为true，表示全量查询。设置为false或不传，表示分页查询 |
| pageNo | Int | 否 | 页码，即第几页。默认值为1 |
| pageSize | Int | 否 | 每页数据的条数。默认值为10 |
响应码
| HTTP Status Code | 说明 |
|---|---|
| 200 | 查询成功 |
| 400 | 负载均衡查询请求参数无效 |
响应体
| 字段名称 | 类型 | 是否一定存在 | 说明 |
|---|---|---|---|
| total | Int | 是 | 负载均衡总数 |
| loadBalanceDetail | Array<LoadBalanceDetail> | 是 | 负载均衡详情 |
| pageNo | String | 否 | 页码，即第几页。分页查询时存在 |
| pageSize | String | 否 | 每页数据的条数。分页查询时存在 |
LoadBalanceDetail 类型说明
| 字段名称 | 类型 | 是否一定存在 | 说明 |
|---|---|---|---|
| loadBalanceId | String | 是 | 负载均衡Id |
| name | String | 是 | 负载均衡名称 |
| status | String | 是 | 负载均衡是否被引用 |
| dispatchMode | String | 是 | 负载均衡策略 |
| sessionMode | String | 是 | 会话保持 |
| detectConfig | Obeject<DetectConfig> | 是 | 健康探测配置 |
| originPoolIds | Array<String> | 是 | 负载均衡使用的源站池id数组 |
| weightList | Array<String> | 是 | 权重列表。当负载均衡策略为加权轮询时，其值代表各源站池权重。否则，为空数组 |
| fallbackOriginPoolId | String | 是 | 兜底源站池Id，未设置为null |
| originPoolCount | Int | 是 | 引用源站池数量 |
| instance | Array |
是 | 该负载均衡被哪个实例所引用 |
DetectConfig 类型说明
| 字段名称 | 类型 | 是否一定存在 | 说明 |
|---|---|---|---|
| healthCheckType | String | 否 | 健康探测类型 |
| probeInterval | Int | 是 | 探测间隔 |
| probeMinSuccesses | Int | 是 | 健康阈值，探测最小成功阈值，与探测最大失败阈值保持一致 |
| probeMaxFails | Int | 是 | 健康阈值，探测最大失败阈值，与探测探测最小成功阈值保持一致 |
| probeTimeout | Int | 是 | 探测超时时间 |
| probeSucceedCode | String | 否 | 预期状态码。当健康探测类型为 HTTPS/HTTP 时存在 |
| probeUrl | String | 否 | 探测路径，当健康探测类型为 HTTPS/HTTP 时存在 |
| probeMethod | String | 否 | 探测请求方法，当健康探测类型为 HTTPS/HTTP 时存在 |
| checkData | String | 否 | 探测请求内容。当健康探测类型为 UDP 时存在 |
| checkResult | String | 否 | 探测返回结果。当健康探测类型为 UDP 时可能存在 |
Instance 类型说明
| 字段名称 | 类型 | 是否一定存在 | 说明 |
|---|---|---|---|
| domain | String | 否 | 引用该负载均衡的实例为域名 |
| type | String | 否 | 实例类型 |
| site | String | 否 | 该实例所属站点 |
请求示例1：全量查询
Plain Text
1GET /v2/geo/load-balance?siteId=1&fetchAll=true&name=test&id=eo_lb_gG5WnKassxm6 HTTP/1.1
2Host: geo.baidubce.com
3Authorization: xxx
4Content-Type: application/json;charset=utf-8
5Accept-Encoding: gzip响应示例1
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 "total": 1,
8 "loadBalanceDetail": [
9 {
10 "loadBalanceId": "eo_lb_gG5WnKassxm6",
11 "name": "test",
12 "status": "ON",
13 "dispatchMode": "weight_mode",
14 "sessionMode": "IP",
15 "detectConfig": {
16 "healthCheckType": "ICMP",
17 "probeInterval": 10,
18 "probeMinSuccesses": 5,
19 "probeMaxFails": 5,
20 "probeTimeout":3
21 },
22 "originPoolIds": [
23 "geo_X8zcYPHclKlz",
24 "geo_D7Qts5KDPXfl"
25 ],
26 "weightList": [
27 10,
28 20
29 ],
30 "fallbackOriginPoolId": "geo_D7Qts5KDPXfl",
31 "originPoolCount": 2,
32 "instance": [
33 {
34 "domain": "1.test-eo.com",
35 "type": "DOMAIN",
36 "site": "test-eo.com"
37 },
38 {
39 "domain": "2.test-eo.com",
40 "type": "DOMAIN",
41 "site": "test-eo.com"
42 }
43 ]
44 }
45 ]
46}请求示例2：分页查询
Plain Text
1GET /geo/load-balance?siteId=1&name=test&id=eo_lb_gG5WnKassxm6&pageNo=1&pageSize=10 HTTP/1.1
2Host: geo.baidubce.com
3Authorization: xxx
4Content-Type: application/json;charset=utf-8
5Accept-Encoding: gzip响应示例2
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 "pageNo": 1,
8 "pageSize": 10,
9 "total": 1,
10 "loadBalanceDetail": [
11 {
12 "loadBalanceId": "eo_lb_gG5WnKassxm6",
13 "name": "test",
14 "status": "ON",
15 "dispatchMode": "weight_mode",
16 "sessionMode": "IP",
17 "detectConfig": {
18 "healthCheckType": "ICMP",
19 "probeInterval": 10,
20 "probeMinSuccesses": 5,
21 "probeMaxFails": 5,
22 "probeTimeout":3
23 },
24 "originPoolIds": [
25 "geo_X8zcYPHclKlz",
26 "geo_D7Qts5KDPXfl"
27 ],
28 "weightList": [
29 10,
30 20
31 ],
32 "fallbackOriginPoolId": "geo_D7Qts5KDPXfl",
33 "originPoolCount": 2,
34 "instance": [
35 {
36 "domain": "1.test-eo.com",
37 "type": "DOMAIN",
38 "site": "test-eo.com"
39 },
40 {
41 "domain": "2.test-eo.com",
42 "type": "DOMAIN",
43 "site": "test-eo.com"
44 }
45 ]
46 }
47 ]
48}评价此篇文章