查询服务列表
更新时间：2026-09-21
该接口用于分页查询指定 AI 网关实例下的服务，支持按关键字、服务类型以及 Model 场景或协议筛选，并返回 API 数量和域名信息。
请求结构
Plain Text
1POST /?action=DescribeServicesByPage 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 "searchContent": searchContent,
16 "serviceType": serviceType,
17 "modelScene": modelScene,
18 "modelProtocol": modelProtocol
19}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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 |
| searchContent | String | 否 | RequestBody参数 | 服务名称，模糊匹配 |
| serviceType | String | 否 | RequestBody参数 | 服务类型：HTTP_SERVICE（HTTP 服务）/MODEL_SERVICE（Model 服务）/AGENT_SERVICE（Agent 服务） |
| modelScene | String | 否 | RequestBody参数 | 模型场景：TEXT_GENERATION/IMAGE_GENERATION/OTHER/VIDEO_GENERATION/EMBEDDING/RERANK/AUDIO |
| modelProtocol | String | 否 | RequestBody参数 | Model 服务协议：OPENAI_COMPATIBLE/ANTHROPIC_COMPATIBLE/QIANFAN/CUSTOM_HTTP/CUSTOM_WEBSOCKET/DOUBAO/BAILIAN/ORIGINAL |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| orderBy | String | 排序字段 |
| order | String | 排序方向：asc/desc |
| pageNo | int | 页码 |
| pageSize | int | 每页数据项数目 |
| totalCount | long | 符合条件的数据项总数 |
| result | List<ListAiGwServiceUO> | 当前页的服务列表 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: instanceId must not be blank | 400 | 必填参数缺失或格式不合法，instanceId 不能为空 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON，无法解析，请检查 JSON 语法和字段类型 |
| InstanceNotExist | Instance not exist. | 404 | instanceId 对应的网关实例不存在、不属于当前账号或已释放 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持，请使用 application/json |
请求示例
Plain Text
1POST /v/?action=DescribeServicesByPage 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": 2,
13 "result": [
14 {
15 "serviceId": "svc-a1b2c3d4",
16 "serviceName": "对话服务",
17 "serviceType": "MODEL_SERVICE",
18 "modelScene": "TEXT_GENERATION",
19 "modelProtocol": "OPENAI_COMPATIBLE",
20 "modelProtocolRoutes": [
21 {
22 "id": "chat-completions",
23 "name": "对话补全",
24 "enabled": true,
25 "method": "POST",
26 "path": "/v1/chat/completions",
27 "matchType": "Exact",
28 "matchPath": "/v1/chat/completions"
29 }
30 ],
31 "modelBasePath": "/v1",
32 "modelBasePathStrip": false,
33 "modelBackendStrategy": "SINGLE",
34 "apiCount": 1,
35 "domainCount": 1,
36 "defaultPrivateDomain": "svc-a1b2c3d4.internal.baidubce.com",
37 "defaultPublicDomain": "svc-a1b2c3d4.baidubce.com",
38 "domains": [
39 {
40 "serviceDomainId": "dm-a1b2c3d4",
41 "domainName": "api.example.com",
42 "protocolType": "HTTPS",
43 "type": "custom"
44 }
45 ],
46 "consumerAuthEnabled": false,
47 "updateTime": "2026-09-03T10:30:00Z"
48 },
49 {
50 "serviceId": "svc-b2c3d4e5",
51 "serviceName": "订单服务",
52 "serviceType": "HTTP_SERVICE",
53 "modelScene": null,
54 "modelProtocol": null,
55 "modelProtocolRoutes": null,
56 "modelBasePath": null,
57 "modelBasePathStrip": null,
58 "modelBackendStrategy": null,
59 "apiCount": 3,
60 "domainCount": 1,
61 "defaultPrivateDomain": "svc-b2c3d4e5.internal.baidubce.com",
62 "defaultPublicDomain": "svc-b2c3d4e5.baidubce.com",
63 "domains": [],
64 "consumerAuthEnabled": true,
65 "updateTime": "2026-09-03T10:20:00Z"
66 }
67 ]
68}评价此篇文章