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

限制说明

使用说明

  • start_time 和 end_time 为毫秒时间戳,最大范围 183 天。
  • 默认只匹配在时间窗内创建的 Issue;by_intersection=true 时,只要 Issue 在 end_time 之前创建且最近出现时间不早于 start_time 即匹配。
  • 私有应用的 Issue 会被排除,除非调用方是账户所有者或管理员、应用创建者,或应用所属团队的成员。
  • statuses 按状态过滤,可选值:for_review、reviewed、ignored、resolved。
  • orderby 支持:created_at、updated_at(默认)、session_count、error_count、severity。按 severity 排序时,没有严重性的 Issue 总是排在最后。
  • 使用 dql 或 sql 进行高级过滤,两者不可同时使用。

授权

app_key
string
query
必填

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

请求体

application/json

查询 Issue 列表的过滤参数。

end_time
integer<int64>
必填

时间范围结束,Unix 毫秒时间戳。需大于 start_time,最大跨度 183 天。

start_time
integer<int64>
必填

时间范围起点,Unix 毫秒时间戳(秒级时间戳会被拒绝)。默认按 Issue 创建时间匹配,by_intersection 为 true 时按活跃区间匹配。

application_ids
string[]

按应用 ID 过滤;应用 ID 可通过 POST /rum/application/list 获取。

asc
boolean

为 true 时升序排列;默认降序。

by_intersection
boolean

为 true 时按时间交集匹配:返回在时间窗口内仍有活动的 Issue(last_seen_timestamp 不早于 start_time),即使其创建于窗口之前;默认 false 仅返回创建于窗口内的 Issue。

dql
string

DQL 高级过滤查询。字段名必须属于 issue 范围(可通过 POST /rum/field/list 并传 scopes: ["issue"] 查询);不带字段名的全文检索词匹配错误信息。不能与 sql 同时使用。过滤条件中的取值列表(field:(a OR b ...))最多包含 100 个值。

error_required
boolean

为 true 时仅返回有关联错误事件的 Issue。

limit
integer

每页条数,范围 1–100,默认 20。

必填范围: 1 <= x <= 100
orderby
enum<string>

排序字段;缺省按 updated_at 排序。

可用选项:
created_at,
updated_at,
session_count,
error_count,
severity
p
integer

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

必填范围: x >= 1
sql
string

SQL 风格的 WHERE 条件,用于高级过滤,不带 WHERE 关键字(例如 error_count > 100)。字段名必须属于 issue 范围;包含 SELECT 的内容会被拒绝。不能与 dql 同时使用。过滤条件中的取值列表(field IN (...))最多包含 100 个值。

statuses
enum<string>[]

按处理状态过滤;传入其他值会被参数校验拒绝。

可用选项:
for_review,
reviewed,
ignored,
resolved
suspected_causes
enum<string>[]

按疑似根因分类过滤。

可用选项:
api.failed_request,
network.error,
code.exception,
code.invalid_object_access,
code.invalid_argument,
unknown
team_ids
integer<int64>[]

按团队 ID 过滤;团队 ID 可通过 POST /team/list 获取。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

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