跳转到主要内容
POST
更新 Issue

限制说明

使用说明

  • 只应用请求中携带的字段;status 与当前状态相同时不会产生任何变化。
  • 将未解决的 Issue 的 status 设为 resolved 会记录 resolved_at 和 resolved_by 并清除 regression;把已解决的 Issue 改为其他状态会清空 resolved_at 和 resolved_by。
  • resolve_mode 只在同时传 status: resolved 时生效,此时不传默认为 any;对已解决的 Issue 传 status: resolved 加新的 resolve_mode 可以只修改解决方式。
  • 应用开启告警时,将 Issue 设为已解决会立即发送其恢复告警。
  • 设置 suspected_cause 会把根因标记为用户指定(suspected_cause.source 为 user,person_id 为调用者),之后自动分析不会再覆盖它。
  • issue_id 不存在时返回 InvalidParameter(“The specified issue does not exist”)。
  • Issue 所属的私有应用调用者无权访问时,返回 AccessDenied(“You do not have permission to access this application”)。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json

更新 Issue 的参数。

issue_id
string
必填

要更新的 Issue ID,可通过 POST /rum/issue/list 获取。

status
enum<string>

新状态。将未解决的 Issue 设为 resolved 会记录解决时间与操作人并清除 regression;从 resolved 改为其他状态会清除解决时间与操作人。不传则保持当前状态。

可用选项:
for_review,
reviewed,
ignored,
resolved
resolve_mode
enum<string>

Issue 已解决后错误再次出现时的处理方式。只在同时传 status: resolved 时生效,此时不传默认为 any;传其他状态时忽略。

可用选项:
any,
version
suspected_cause
enum<string>

新的疑似原因;设置后原因来源会标记为 user(用户指定),覆盖自动判定结果。取值:

可用选项:
api.failed_request,
network.error,
code.exception,
code.invalid_object_access,
code.invalid_argument,
unknown

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

无返回数据。不同接口的 data 可能是 {},也可能不出现在响应中;请只根据 HTTP 200 且没有 error 判断成功。