跳转到主要内容
POST
查询数据源列表

限制说明

使用说明

  • 省略 type 和 name 时返回你有权查询的所有数据源;type、name 均为精确匹配。无法识别的 type 返回空数组。结果不分页。
  • 只返回调用方有权查询的数据源(见 readonly_team_ids);每项带有 my_perm(manage 或 readonly)。
  • 列表项中的 payload 恒为 null。如需读取自己可管理的数据源的配置,请使用 /monit/datasource/info。
  • 列表项中的 address 会对每个逗号分隔的地址去掉用户信息(user:password@)、查询串和片段(#...)。/monit/datasource/info 返回保存的原始地址。

授权

app_key
string
query
必填

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

请求体

application/json

查询数据源列表的过滤参数。

type
enum<string>

仅返回该类型的数据源;省略或留空返回所有类型。无法识别的值不匹配任何数据源,返回空数组。

告警类(可用于告警规则评估):

  • prometheus:兼容 Prometheus 的指标数据源。
  • loki:Grafana Loki 日志。
  • mysql:MySQL。
  • oracle:Oracle 数据库。
  • postgres:PostgreSQL。
  • clickhouse:ClickHouse。
  • elasticsearch:Elasticsearch。
  • sls:阿里云日志服务(SLS)。
  • tencent_cls:腾讯云日志服务(CLS)。
  • victorialogs:VictoriaLogs。

仅诊断类(不能用于告警评估,alerting_enabled 恒为 false):

  • redis_node:单个 Redis 节点。
  • redis_sentinel:Redis Sentinel。
  • mongodb_mongod:MongoDB mongod 实例。
  • mongodb_mongos:MongoDB mongos 路由。
  • kafka:Kafka 集群。
可用选项:
prometheus,
loki,
mysql,
oracle,
postgres,
clickhouse,
elasticsearch,
sls,
tencent_cls,
victorialogs,
redis_node,
redis_sentinel,
mongodb_mongod,
mongodb_mongos,
kafka
name
string

仅返回名称与该值完全相等的数据源(名称在账户内唯一,因此最多一条)。省略或留空表示不按名称过滤。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object[]

账户下调用方有权查询的数据源,按名称排序;没有匹配项时为空数组。列表不读取 payload,因此每项的 payload 均为 null;每项另带 my_perm。