跳转到主要内容
POST
查询产物列表

限制说明

使用说明

  • scope 可选 all(默认:调用者自己的个人产物加上其所属全部团队的产物)、personal(仅调用者自己的个人产物)、team(仅调用者所属团队拥有的产物)。未知取值按 all 处理。
  • 可见范围按 app_key 所属成员的身份和实际团队成员关系计算,账户所有者和管理员在此也不会多看到产物。要按 ID 打开账户内任意产物,请用 /safari/artifact/gallery/get。
  • 调用者置顶的产物总排在最前;其余默认按 updated_at 倒序,可通过 orderby/asc 调整。

授权

app_key
string
query
必填

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

请求体

application/json

产物库列表的过滤与分页参数。

scope
enum<string>
默认值:all

可见范围。all(默认)= 调用者自己的个人产物 + 其所在团队的产物;personal = 仅调用者自己创建的;team = 仅调用者所属团队的团队产物。

可用选项:
all,
personal,
team
team_ids
integer<int64>[]

只看这些团队拥有的产物,与 scope 条件取交集。小于等于 0 的 ID 会被忽略;调用者不属于的团队不会有返回,且设置该字段后不会返回个人产物。

query
string

按产物标题做大小写不敏感的子串匹配。

page
integer
默认值:1

页码,从 1 开始。小于 1 时按 1 处理。

limit
integer
默认值:20

每页条数。小于 1 时按 20 处理;大于 100 时按 100 处理(不会报错)。

orderby
enum<string>

排序字段:created_at(发布时间)或 updated_at(最近变更时间)。留空时按 updated_at 倒序。无论哪种排序,调用者置顶的产物都排在最前,相同值再按 artifact_id 排序。

可用选项:
created_at,
updated_at
asc
boolean

为 true 时升序,为 false 时降序。仅在设置了 orderby 时生效。

响应

成功

所有 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

一页产物列表。