查询API列表
更新时间：2026-09-20
该接口用于分页查询指定 AI 网关实例下的 API，支持按搜索内容、服务、后端、路由类型、API 类型和发布状态筛选。
列表按逻辑 API 返回；MODEL_NAME 的匹配规则会聚合到入口记录中，不会作为独立分页项。
请求结构
Plain Text
1POST /?action=DescribeApisByPage 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 "backendId": backendId,
17 "serviceId": serviceId,
18 "routeType": routeType,
19 "apiType": apiType,
20 "publishStatus": publishStatus
21}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| keyword | String | 否 | RequestBody参数 | 关键字 |
| keywordType | String | 否 | RequestBody参数 | 关键字类型 |
| pageNo | int | 否 | RequestBody参数 | 页码 |
| pageSize | int | 否 | RequestBody参数 | 每页数据项数目 |
| order | String | 否 | RequestBody参数 | 排序方向 |
| orderBy | String | 否 | RequestBody参数 | 排序字段 |
| orders | List<OrderModel> | 否 | RequestBody参数 | 多重排序 |
| filters | List<FilterModel> | 否 | RequestBody参数 | 过滤字段 |
| instanceId | String | 是 | RequestBody参数 | 网关实例 ID |
| searchContent | String | 否 | RequestBody参数 | 查询内容 |
| backendId | String | 否 | RequestBody参数 | 后端 ID |
| serviceId | String | 否 | RequestBody参数 | 服务 ID |
| routeType | String | 否 | RequestBody参数 | 路由类型：HTTP_ROUTE / MODEL_ROUTE / AGENT_ROUTE |
| apiType | String | 否 | RequestBody参数 | API 类型筛选条件：基础 API 传 HTTP_ROUTE / WEB_SOCKET，Agent 路由传 http / websocket |
| publishStatus | String | 否 | RequestBody参数 | 发布状态：PUBLISHED / OFFLINE |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| orderBy | String | 排序字段 |
| order | String | 排序方向 |
| pageNo | int | 页码 |
| pageSize | int | 每页数据项数目 |
| totalCount | long | 数据总条数 |
| result | List<ListAiGwApiUO> | API 列表 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: instanceId must not be blank | 400 | 必填参数缺失或格式不合法，instanceId 不能为空 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON，无法解析，请检查 JSON 语法和字段类型 |
| ResourcePermissionDeny | Resource permission deny. | 401 | 无权限访问指定资源，请确认实例属于当前账号并使用有权限的账号凭证 |
| InstanceNotExist | Instance not exist. | 404 | instanceId 对应的网关实例不存在、不属于当前账号或已释放 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持，请使用 application/json |
请求示例
Plain Text
1POST /?action=DescribeApisByPage 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 "publishStatus": "PUBLISHED"
10}返回示例
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 "pageNo": 1,
9 "pageSize": 20,
10 "totalCount": 1,
11 "result": [
12 {
13 "apiId": "api-a1b2c3d4",
14 "logicalRouteId": "api-a1b2c3d4",
15 "name": "对话API",
16 "apiType": "HTTP_ROUTE",
17 "routeType": "HTTP_ROUTE",
18 "modelBackendStrategy": "SINGLE",
19 "backendCount": 1,
20 "routeSource": "CUSTOM",
21 "publishStatus": "PUBLISHED",
22 "serviceId": "sg-a1b2c3d4",
23 "serviceName": "对话服务",
24 "serviceType": "HTTP_SERVICE",
25 "path": "/v1/chat",
26 "methods": [
27 "POST"
28 ],
29 "priorityNumber": 0,
30 "consumerAuthEnabled": false,
31 "updateTime": "2026-09-08T10:30:00Z"
32 }
33 ]
34}评价此篇文章