Skip to main content
POST
查询仪表盘列表

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

列出某个目录下的仪表盘。与搜索不同,folder_id 必填。

folder_id
integer<uint64>
必填

要列出仪表盘的目录。

必填范围: x >= 1
query
string

可选空格分隔的搜索词,匹配标题与描述;最多 128 个 Unicode 字符。

Maximum string length: 128
sort
object[]

排序键;默认按 updated_at 倒序。

Maximum array length: 2
p
integer

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

必填范围: x >= 1
limit
integer

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

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

响应

Success

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

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