Skip to main content
POST
更新数据源

限制说明

使用说明

  • 每次调用都会记录到账户审计日志,仅通过凭据字段配置连接凭据。
完整支持类型与凭据行为见请求/响应 Schema。仅诊断类型不能启用告警。创建时省略 enabled 默认为 true,更新时省略保留当前值;enabled 或 alerting_enabled 的显式 null 非法。诊断密码及 Kafka 私钥在响应中省略,环境变量引用除外;更新时省略秘密字段保留原值,空字符串清除。其他数据源凭据可能返回,应作为敏感数据处理。

授权

app_key
string
query
必填

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

请求体

application/json

创建或更新数据源的请求体。id 仅在更新时必填。address 除 Elasticsearch deployment=cloud 外均为必填。

type_ident
string
必填

数据源类型标识。支持:prometheus, loki, mysql, oracle, postgres, clickhouse, elasticsearch, sls, tencent_cls, victorialogs, redis_node, redis_sentinel, mongodb_mongod, mongodb_mongos, kafka

name
string
必填

数据源显示名称,查询与诊断接口中的 ds_name 引用的就是这个名称。

payload
object
必填

类型相关配置块,必须包含与 type_ident 匹配的键。 诊断类型的 password 和 Kafka tls_key 在响应中省略,${env:...} 引用除外;更新时省略保留已保存的秘密,显式空字符串清除。其他配置字段保持原有行为。

edge_cluster_name
string
必填

负责使用该数据源评估规则的 Monitors Edge 集群名称。

id
integer<uint64>

数据源 ID。更新时必填,创建时省略。

note
string

可选描述。

address
string

连接地址。除 elasticsearchdeployment: cloud 部署外均为必填。Prometheus/Loki/VictoriaLogs 为 HTTP URL;MySQL/Oracle/Postgres/ClickHouse 为 host:port;SLS 为不含 http(s):// 前缀的 endpoint;tencent_cls 必须为 cls.tencentcloudapi.comcls.internal.tencentcloudapi.com(要求 Monitors edge >= v0.66.0)。 Redis/MongoDB 诊断类型使用单个 host:port(IPv6 加方括号),不接受 URI、userinfo 或查询参数。Kafka 使用 1–32 个不重复、逗号分隔的 host:port 引导地址;payload 不含 broker 列表。规范化后最多 4096 个字符。

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。有启用规则引用时,关闭用途返回冲突。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

单个监控数据源。