Skip to main content
POST
更新数据源

限制说明

使用说明

  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

凭据字段

info / create / update 的响应不返回凭据明文。passwordbasic_auth_passwordapi_keyservice_tokenaccess_key_secrettls_keytls_key_pwd 等字段一律以 ****** 占位返回;原本就没配置的字段仍返回空字符串。sls.access_key_id 是标识而非凭据,照常返回真实值。 更新时把 ****** 原样提交表示沿用已存值,留空同样按沿用处理;要轮换凭据就直接提交新值。 创建时没有可沿用的旧值——若把从别处读来的 ****** 当作真实口令提交,存下来的就是字面量 ******,数据源会连不上。

授权

app_key
string
query
必填

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

请求体

application/json

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

type_ident
string
必填

数据源类型标识,可选值:prometheuslokimysqloraclepostgresclickhouseelasticsearchslsvictorialogs

name
string
必填

数据源显示名称。

payload
object
必填

类型相关配置块,必须包含与 type_ident 匹配的键。

edge_cluster_name
string
必填

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

id
integer<uint64>

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

note
string

可选描述。

address
string

连接地址。Prometheus/Loki/VictoriaLogs 为 HTTP URL;MySQL/Oracle/Postgres/ClickHouse 为 host:port;SLS 为不含 http/https 前缀的 endpoint;Elasticsearch cloud 部署无需填写。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

单个监控数据源。