跳转到主要内容
POST
搜索仪表盘

限制说明

使用说明

  • query 至少需要一个词;为空或只含空白时以 InvalidParameter 失败。标题或描述中包含每一个词(子串匹配)的仪表盘才会命中。
  • 读取对账户内所有成员开放。scope 决定搜索范围:mine 为所在团队与本人创建的目录及其子孙目录;all 为账户下的全部目录。不传 scope 时,账户所有者、管理员和拥有全部团队查看范围的角色按 all,其他成员按 mine。回收站中的仪表盘不会返回。
  • 排序键为 title 与 updated_at,最多两个且不可重复;默认按 updated_at 倒序。

授权

app_key
string
query
必填

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

请求体

application/json

在调用方可读的全部目录中搜索仪表盘。搜索词至少需要一个单词。

query
string
必填

以空白分隔的搜索词;至少一个词,最多 128 个 Unicode 字符。标题或描述中包含每一个词的仪表盘才会命中。

Required string length: 1 - 128
scope
enum<string>

响应覆盖哪些文件夹。mine 为调用方所在团队的文件夹与调用方创建的文件夹及其子孙文件夹;all 为账户下的全部文件夹。不传时,账户所有者、管理员和拥有全部团队查看范围的角色按 all,其他成员按 mine。其他值返回 InvalidParameter。

可用选项:
mine,
all
sort
object[]

排序键;默认按 updated_at 倒序。

Maximum array length: 2
p
integer

页码,从 1 开始,默认 1。

必填范围: x >= 1
limit
integer

每页条数,1~100,默认 20。

必填范围: 1 <= x <= 100

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

一页仪表盘及其匹配总数。