跳转到主要内容
POST
查询知识列表

限制说明

使用说明

  • 返回账户知识,以及调用者所属团队的知识。对所有调用者都一样——Owner 和管理员也看不到自己未加入团队的知识。
  • 账户知识只有在被创建后才会出现(通过 POST /safari/knowledge/get、不带 pack_id 的文件接口或 POST /safari/knowledge/pack/ensure);本接口不会创建它。
  • 先按 query 过滤,再用 p/limit 对过滤结果分页;total 为过滤后的总数。p 与 limit 都不传则返回全部。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

知识列表的过滤与分页参数。

p
integer

页码,从 1 开始。p 与 limit 都不传(或 ≤ 0)时不分页,返回全部匹配结果;只传 limit 时 p 默认为 1。

limit
integer

每页条数。传了 p 但未传 limit 时默认为 20;不限制上限。

scope
enum<string>

返回哪些范围:

  • all(默认):账户知识(include_account 为 false 时除外)加上可见的团队知识。
  • account:仅账户知识,忽略 include_account 和 team_ids。
  • team:仅团队知识,可用 team_ids 进一步筛选;忽略 include_account。
可用选项:
all,
account,
team
query
string

对知识 ID、范围、范围 ID、账户 ID 和团队名称做大小写不敏感的子串过滤;账户知识还可匹配 账户/账号,团队知识还可匹配 团队。首尾空格会被忽略。

Maximum string length: 128
team_ids
integer<int64>[]

将团队知识限定在这些团队 ID 内。调用者不属于的团队 ID 会被静默丢弃——对所有调用者都一样,包括 Owner 和管理员。

include_account
boolean | null

scope 为 all 或未传时是否包含账户知识,默认 true。

响应

成功

所有 Flashduty 公开 API 共用的标准响应结构。成功时 data 为接口专属载荷且不含 error;失败时 error 存在而 data 缺失。request_id 始终存在,并会同步写入 Flashcat-Request-Id 响应头。

request_id
string
必填

本次请求的唯一 ID,与 Flashcat-Request-Id 响应头一致。反馈问题时请携带该 ID。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

error
object

响应结构中的错误 payload,仅在非 2xx 响应时出现。

data
object

可见的知识及过滤后的总数。