查询变更列表

在指定时间窗口内查询变更记录，支持过滤、搜索与分页。

POST /change/list

查询变更列表

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/change/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": 1716960000,
  "end_time": 1717046400,
  "p": 1,
  "limit": 10,
  "integration_ids": [
    362
  ],
  "orderby": "start_time",
  "asc": false,
  "include_events": false
}
'

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 1,
    "has_next_page": false,
    "items": [
      {
        "change_id": "664a1b2c3d4e5f6a7b8c9d0e",
        "account_id": 10001,
        "channel_id": 5001,
        "channel_name": "Production",
        "channel_status": "active",
        "integration_id": 362,
        "integration_name": "GitHub Deploy",
        "title": "Deploy api-server v2.3.1",
        "description": "Rolling deploy to production cluster",
        "change_key": "deploy-api-server-2311",
        "change_status": "Done",
        "start_time": 1716962400,
        "last_time": 1716962700,
        "end_time": 1716963000,
        "labels": {
          "service": "api-server",
          "env": "prod"
        },
        "link": "https://github.com/acme/api-server/actions/runs/123"
      }
    ]
  }
}

​

限制说明

项目	说明
速率限制	每个账户 1,000 次/分钟；50 次/秒
权限要求	无 —— 持有有效的 app_key 即可调用

授权

app_key · string · query · 必填

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

请求体

application/json

start_time · integer<int64>

查询窗口起始的 Unix 时间戳（秒）。

end_time · integer<int64>

查询窗口结束的 Unix 时间戳（秒）。

p · integer<int64>

页码，从 1 开始。

必填范围: x >= 1

limit · integer<int64> · 默认值: 10

每页条数。

必填范围: 1 <= x <= 100

channel_ids · integer<int64>[]

按协作通道 ID 过滤。

integration_ids · integer<int64>[]

按上报集成 ID 过滤。

orderby · enum<string>

结果排序字段。

可用选项: start_time, last_time

asc · boolean

为 true 时升序排序。

include_events · boolean

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

query · string

对变更字段进行全文或正则搜索。

响应

200

application/json

Success

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

每个接口自己的业务 payload，详见各接口的 200 响应 schema。

Show child attributes