跳转到主要内容
POST
查询 SLS 项目列表

限制说明

使用说明

  • id 指定的数据源类型必须为 sls,其他类型返回 InvalidParameter。
  • 调用者需要有该数据源的查询权限(见数据源的 readonly_team_ids),否则返回 403 AccessDenied。
  • 使用 query 过滤项目列表,使用 offset 和 size 分页;count 为当前页项目数,total 为满足过滤条件的项目总数。
  • 请求会转发给该数据源所属的 Monitors edge 集群,由 edge 使用已保存的凭据调用阿里云,30 秒超时。该集群没有在线的 edge 实例时返回 InvalidParameter;edge 版本不支持元数据发现时返回 HTTP 503 ServiceUnavailable。

授权

app_key
string
query
必填

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

请求体

application/json

查询 SLS 项目列表的参数。

id
integer<uint64>
必填

SLS 类型数据源的 ID,可通过 POST /monit/datasource/list 获取。

query
string

按项目名称或描述模糊过滤,名称匹配的结果在前,留空返回全部。

offset
integer

分页偏移量。

size
integer

每页大小,传 0 时服务端默认 200。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

一页阿里云 SLS 项目。