跳转到主要内容
POST
查询变更列表

限制说明

使用说明

  • start_time 和 end_time 均为必填:start_time 必须小于 end_time,且时间跨度不超过 31 天。
  • 变更的 [start_time, last_time] 区间与查询时间窗有重叠即视为匹配。
  • 将 include_events 设为 true 可在 events 中附带每个变更的原始变更事件。

授权

app_key
string
query
必填

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

请求体

application/json
start_time
integer<int64>
必填

查询时间窗起点,Unix 时间戳(秒)。实际为必填:必须小于 end_time,时间跨度不超过 31 天。变更的 [start_time, last_time] 区间与时间窗有重叠即匹配。

必填范围: x >= 0
end_time
integer<int64>
必填

查询时间窗终点,Unix 时间戳(秒)。实际为必填,约束见 start_time。

必填范围: x >= 0
p
integer<int64>
默认值:1

页码,从 1 开始,默认 1。

必填范围: x >= 1
limit
integer<int64>
默认值:10

每页条数,1-100,默认 10。

必填范围: 1 <= x <= 100
channel_ids
integer<int64>[]

按协作空间 ID 过滤。

协作空间 ID。

integration_ids
integer<int64>[]

按上报集成 ID 过滤。提供时至少 1 个。

Minimum array length: 1

集成 ID。

orderby
enum<string>

排序字段:start_time 或 last_time,默认 start_time。

可用选项:
start_time,
last_time
asc
boolean

为 true 时升序排序,默认降序。

include_events
boolean

为 true 时返回每个变更的底层变更事件。

query
string

对变更标题、change_key、描述做大小写不敏感的子串或正则匹配。非法正则按字面量匹配。

filters
object[]

结构化过滤条件,与查询按 AND 组合(如按标签过滤)。以 incident 开头的 key 会被忽略。支持的 key 为 labels.<名称>、title、description、change_key、change_status、link;key 不做校验,其他 key 在 IN 下不匹配任何变更,在 NOTIN 下匹配全部变更。oper 不区分大小写,vals 为空的条件会被忽略。

data_source_ids
integer<int64>[]
已弃用

已废弃:请使用 integration_ids。提供时至少 1 个。

Minimum array length: 1

集成 ID。

data_source_id
integer<int64>
已弃用

已废弃:请使用 integration_ids。按单个集成 ID 过滤。

必填范围: x >= 1
integration_id
integer<int64>
已弃用

已废弃:请使用 integration_ids。按单个集成 ID 过滤。

必填范围: x >= 1

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

接口返回的数据,格式见各接口的 200 响应。没有返回数据的接口会返回 {} 或完全不带 data。