查询后端列表
更新时间：2026-09-07
该接口用于分页查询指定 AI 网关实例下的后端，支持按名称、后端类型、AI 大模型接口协议、关联 API 和 Model 服务协议筛选，并返回每个后端的关联 API 数量
注意事项：
- 传入
modelProtocol时，标准协议仅返回与该协议兼容的 AI 大模型后端，自定义协议返回全部 AI 大模型后端
请求结构
Plain Text
1POST /?action=DescribeBackendsByPage HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "keyword": keyword,
7 "keywordType": keywordType,
8 "pageNo": pageNo,
9 "pageSize": pageSize,
10 "order": order,
11 "orderBy": orderBy,
12 "orders" : [order],
13 "filters" : [filter],
14 "instanceId": instanceId,
15 "name": name,
16 "aiModel": aiModel,
17 "modelProtocol": modelProtocol,
18 "backendType": backendType,
19 "apiId": apiId
20}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| keyword | String | 否 | RequestBody参数 | 搜索关键字，与 keywordType 配合使用 |
| keywordType | String | 否 | RequestBody参数 | 搜索关键字对应的字段名 |
| pageNo | int | 否 | RequestBody参数 | 页码，从 1 开始，不传默认 1 |
| pageSize | int | 否 | RequestBody参数 | 每页数据项数目，取值 1~1000，不传默认 1000 |
| order | String | 否 | RequestBody参数 | 排序方法：asc/desc |
| orderBy | String | 否 | RequestBody参数 | 排序字段 |
| orders | List<OrderModel> | 否 | RequestBody参数 | 多字段排序条件，与 order、orderBy 二选一 |
| filters | List<FilterModel> | 否 | RequestBody参数 | 过滤条件列表 |
| instanceId | String | 是 | RequestBody参数 | 网关实例 ID |
| name | String | 否 | RequestBody参数 | 后端名称，模糊匹配 |
| aiModel | String | 否 | RequestBody参数 | AI 大模型接口协议：openai/anthropic/raw |
| modelProtocol | String | 否 | RequestBody参数 | Model 服务协议：OPENAI_COMPATIBLE/ANTHROPIC_COMPATIBLE/QIANFAN/CUSTOM_HTTP/CUSTOM_WEBSOCKET/DOUBAO/BAILIAN/ORIGINAL |
| backendType | String | 否 | RequestBody参数 | 后端类型：aiModel（AI 大模型）/ip（固定 IP）/domain（域名）/agent（Agent 服务） |
| apiId | String | 否 | RequestBody参数 | 路由 ID，按该路由已绑定的后端过滤 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| orderBy | String | 排序字段 |
| order | String | 排序方法：asc/desc |
| pageNo | int | 页码 |
| pageSize | int | 每页数据项数目 |
| totalCount | long | 符合条件的数据项总数 |
| result | List<ListAiGwBackendUO> | 当前页的后端列表 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: instanceId must not be blank | 400 | 必填参数缺失或格式不合法，instanceId 不能为空 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON，无法解析，请检查 JSON 语法和字段类型 |
| ResourceNotExist | Model service backend mapping not configured or invalid for protocol {modelProtocol}. | 404 | 传入的 modelProtocol 没有对应的可用后端映射配置，请确认协议取值正确或联系技术支持 |
| ApiNotExist | Api not exist. | 404 | 按 apiId 过滤时该路由不存在、不属于当前账号或已删除 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持，请使用 application/json |
请求示例
Plain Text
1POST /?action=DescribeBackendsByPage HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "instanceId": "gw-a1b2c3d4",
7 "pageNo": 1,
8 "pageSize": 20
9}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "orderBy": null,
9 "order": null,
10 "pageNo": 1,
11 "pageSize": 20,
12 "totalCount": 4,
13 "result": [
14 {
15 "backendId": "bd-a1b2c3d4",
16 "name": "OpenAI 生产后端",
17 "apiCount": 2,
18 "backendType": "aiModel",
19 "backendTypeName": "AI大模型",
20 "aiModel": "openai",
21 "provider": "custom",
22 "updateTime": "2026-09-03T10:30:00Z"
23 },
24 {
25 "backendId": "bd-b2c3d4e5",
26 "name": "订单服务 IP 后端",
27 "apiCount": 1,
28 "backendType": "ip",
29 "backendTypeName": "固定IP",
30 "aiModel": null,
31 "provider": null,
32 "updateTime": "2026-09-03T10:20:00Z"
33 },
34 {
35 "backendId": "bd-c3d4e5f6",
36 "name": "支付服务域名后端",
37 "apiCount": 1,
38 "backendType": "domain",
39 "backendTypeName": "域名",
40 "aiModel": null,
41 "provider": null,
42 "updateTime": "2026-09-03T10:10:00Z"
43 },
44 {
45 "backendId": "bd-d4e5f6g7",
46 "name": "Agent 服务后端",
47 "apiCount": 0,
48 "backendType": "agent",
49 "backendTypeName": "Agent",
50 "aiModel": null,
51 "provider": null,
52 "updateTime": "2026-09-03T10:00:00Z"
53 }
54 ]
55}评价此篇文章