跳转到主要内容
POST
更新数据源

限制说明

使用说明

  • 这是整体替换而非局部更新:每次调用都要发送 type_ident、name、edge_cluster_name、payload,以及 address(cloud 部署的 Elasticsearch 除外)。note、address、payload 会覆盖已保存的值,因此省略 note 会将其清空。
  • 省略 enabled、alerting_enabled、manage_team_id、readonly_team_ids 时保持原值。enabled 或 alerting_enabled 传 null 会被拒绝;两个团队字段传 null 表示清除。
  • 密钥:诊断类型省略密码(以及 Kafka 的 tls_key)表示保留已保存的值,传空字符串表示清除;tencent_cls 省略或传空的 secret_key 表示保留已保存的密钥;其他类型需要重新发送凭据。
  • 将 enabled 或 alerting_enabled 设为 false,或修改 type_ident、edge_cluster_name,会关闭使用该数据源的规则上的未恢复告警;重命名时,会关闭 ds_list 名称模式不再匹配新名称的规则上的未恢复告警。
  • 只要仍有已启用的告警规则选中该数据源,关闭 alerting_enabled 会返回 HTTP 409 UndonedOrderExist。
  • 只有账户所有者、管理员、创建者和负责团队成员可以更新数据源(未设置负责团队时,拥有该权限的调用方均可);其他人返回 AccessDenied。ID 不存在或属于其他账户时返回 ResourceNotFound。
  • 每次调用都会记录到账户审计日志。

授权

app_key
string
query
必填

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

请求体

application/json

创建或更新数据源的请求体。id 仅更新时必填,创建时忽略。更新会用请求中的值整体替换 type_ident、name、note、address、payload 和 edge_cluster_name,因此必须全部重新发送;仅 enabled、alerting_enabled、manage_team_id、readonly_team_ids 在省略时保持原值。除 deployment=cloud 的 Elasticsearch 外,address 对所有类型必填。

type_ident
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 集群。

存放类型专属配置的 payload 键与类型同名。

可用选项:
prometheus,
loki,
mysql,
oracle,
postgres,
clickhouse,
elasticsearch,
sls,
tencent_cls,
victorialogs,
redis_node,
redis_sentinel,
mongodb_mongod,
mongodb_mongos,
kafka
name
string
必填

数据源名称;必填,在账户内唯一(不区分类型),即查询接口中的 ds_name。重名时返回 InvalidParameter。

payload
object
必填

类型专属配置块,必须包含与 type_ident 同名的键。更新会整体替换 payload,需要保留的配置(包括非诊断类型的凭据,可通过详情接口读取)都要重新发送。例外:诊断类型省略密码(以及 Kafka 的 tls_key)表示保留已保存的值,传空字符串表示清除;tencent_cls 省略或传空的 secret_key 表示保留已保存的密钥。修改 type_ident 时不会沿用已保存的密钥。序列化后的 JSON 不得超过 65,535 字节。

edge_cluster_name
string
必填

负责评估规则和执行查询的 Monitors edge 集群名称,必须是账户下已存在的 edge 集群,否则返回 InvalidParameter。更新时修改该值会关闭使用此数据源的规则上的未恢复告警。

id
integer<uint64>

数据源 ID。更新时必填(ID 不存在或属于其他账户时返回 ResourceNotFound);创建时忽略。

note
string

自由文本备注。更新时省略或传空字符串会清空已保存的备注。

address
string

连接地址;除 deployment: cloud 的 elasticsearch 外,所有类型都必填。规范化后最长 4096 个字符。各类型格式:

  • prometheus、loki、victorialogs:HTTP URL;不以 http 开头时自动补 http://。
  • mysql、oracle、postgres:host:port。
  • clickhouse:一个或多个以逗号分隔的 host:port,重复地址会被拒绝。
  • self-managed 的 elasticsearch:一个或多个以逗号分隔的 HTTP(S) URL(缺省协议为 http://),各 URL 的查询参数必须一致,重复地址会被拒绝;cloud 部署无需填写。
  • sls:不带 http:// 或 https:// 前缀的 endpoint。
  • tencent_cls:只能是 cls.tencentcloudapi.com 或 cls.internal.tencentcloudapi.com(要求 Monitors edge >= v0.66.0)。
  • redis_node、redis_sentinel、mongodb_mongod、mongodb_mongos:单个 host:port(IPv6 须加方括号),不能含 URI、用户信息或查询串。
  • kafka:1-32 个互不重复、以逗号分隔的 host:port 引导地址(payload 中没有 broker 列表)。
Maximum string length: 4096
enabled
boolean

是否启用业务执行。创建时省略默认为 true;更新时省略保留当前值。显式 false 停用执行;null 非法。不改变 alerting_enabled。

alerting_enabled
boolean

是否允许数据源用于告警。创建时省略:支持告警的类型默认为 true,仅诊断类型默认为 false;更新时省略保留当前值。null 非法。redis_node、redis_sentinel、mongodb_mongod、mongodb_mongos 和 kafka 不允许 true。有启用规则引用时,关闭用途返回冲突。

manage_team_id
integer<uint64> | null

负责团队 ID(含义见响应中的同名字段)。创建时省略表示不指定负责团队;更新时省略保持原值,传 null 或 0 表示清除。readonly_team_ids 非空时必须填写。

readonly_team_ids
integer<uint64>[] | null

允许查询和引用该数据源的团队 ID 列表(含义见响应中的同名字段)。创建时省略表示不限制;更新时省略保持原值,传 null 或空数组表示清除(所有人可查询)。重复值和 0 会被去掉。依赖 manage_team_id:列表非空而未指定负责团队时返回 InvalidParameter。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

单个监控数据源。