跳转到主要内容
POST
查询仪表盘列表

限制说明

使用说明

  • 不返回定义;查看单个仪表盘请调用 POST /rum/dashboard/get。
  • query 同时匹配标题和描述,空格分隔的每个词都须命中。已删除的仪表盘请用 POST /rum/dashboard/trash/list 查询。

授权

app_key
string
query
必填

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

请求体

application/json

列表请求。p 从 1 开始,limit 默认 20,默认按最新在前排序。

query
string

搜索文本,最多 128 个字符。按空格拆分,每个词都须出现在标题或描述中。

sort
object[]

排序方式,最多两个且不重复的字段;默认按 updated_at 倒序。

Maximum array length: 2
p
integer
默认值:1

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

必填范围: x >= 1
limit
integer
默认值:20

每页条数,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

一页仪表盘。