Flashcat API

故障详情

POST

https://api.flashcat.cloud/incident/info

最后修改时间：2025-06-30 06:45:10

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.flashcat.cloud/incident/info?app_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "incident_id": "string"
}'

响应示例

{
    "error": {
        "code": "InvalidParameter",
        "message": "string"
    },
    "data": {
        "incident_id": "string",
        "start_time": 0,
        "end_time": 0,
        "last_time": 0,
        "ack_time": 0,
        "close_time": 0,
        "snoozed_before": 0,
        "incident_status": "Info",
        "incident_severity": "Info",
        "progress": "Triggered",
        "creator_id": 0,
        "closer_id": 0,
        "assigned_to": {
            "person_ids": [
                0
            ],
            "escalate_rule_id": "string",
            "escalate_rule_name": "string",
            "layer_idx": 0,
            "layer_person_reset": {
                "0": {
                    "team_ids": [
                        0
                    ],
                    "person_ids": [
                        0
                    ],
                    "schedule_to_role_ids": {
                        "{schedule_id}": [
                            0
                        ]
                    }
                }
            },
            "type": "assign"
        },
        "responders": [
            {
                "person_id": 0,
                "assigned_at": 0,
                "acknowledged_at": 0
            }
        ],
        "alert_cnt": 0,
        "title": "string",
        "description": "string",
        "impact": "string",
        "root_cause": "string",
        "resolution": "string",
        "num": "string",
        "labels": {},
        "channel_id": 0,
        "channel_name": "string",
        "data_source_id": 0,
        "data_source_type": "string",
        "dedup_key": "string",
        "group_method": "i",
        "ever_muted": true,
        "frequency": "rare"
    }
}

请求参数

Authorization

在 query 添加参数

app_key

示例：

app_key: ********************

Header 参数

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

incident_id

string

必需

故障ID，ObjectID类型

示例

返回响应

🟢200成功

application/json

Body

error

object (DutyError)

仅出现错误时返回

可选

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

data

object (Incident)

故障详情

可选

incident_id

string

必需

故障ID，类型为ObjectID

start_time

integer

开始时间戳，单位秒

必需

end_time

integer

必需

结束时间戳，单位秒。当故障自动恢复时，此值不为0；手动关闭故障时，该值可能为0

last_time

integer

必需

最后一条合入当前故障的告警的开始时间戳，单位秒

ack_time

integer

可选

首次认领时间戳，单位秒。如果有多个人认领告警，该字段为首次认领时间。如果取消认领，该值重置为0

close_time

integer

可选

手动关闭时间戳，单位秒。故障自动恢复时，故障也将自动关闭

snoozed_before

integer

必需

暂缓截止时间戳，单位秒。取消关闭或认领时，该值重置为0

incident_status

enum<string>

必需

故障状态。枚举值：Info，Warning，Critical，Ok

枚举值:

InfoWarningCriticalOk

incident_severity

enum<string>

必需

严重程度。枚举值：Info，Warning，Critical

枚举值:

InfoWarningCritical

progress

enum<string>

必需

处理进度。枚举值：Triggered, In Progress, Closed

枚举值:

TriggeredProcessingClosed

creator_id

integer

必需

发起人ID，仅手动创建故障存在

closer_id

integer

可选

关闭人ID，仅手动关闭时存在

assigned_to

可选

指派信息。最新一次手动或自动指派的信息，升级或重新指派时会发更新该值

responders

array[object (Responder) {3}] | null

可选

处理人列表。该值跟assigned_to无绝对关系，该值可能因人员直接认领或关闭故障而更新。该人员列表信息可能多于assigned_to人员列表

alert_cnt

integer

关联告警数量

可选

title

string

故障标题

必需

description

string

可选

故障描述，可能为传文本、markdown或html类型

impact

string

故障影响

可选

root_cause

string

故障根本原因

可选

resolution

string

故障解决办法

可选

num

string

必需

短标识，可能重复，仅用于快速识别

labels

可选

标签信息，kv，代表故障不同维度信息，提取自集成上报内容

channel_id

integer

可选

协作空间ID，为0代表全局故障

channel_name

string

协作空间名称

可选

data_source_id

integer

可选

来源集成ID，故障聚合的第一条告警的集成来源

data_source_type

string

可选

来源集成类型，故障聚合的第一条告警的集成类型

dedup_key

string

可选

故障去重key，故障聚合的第一条告警的alert_key

group_method

enum<string>

聚合方式

可选

枚举值:

ipn

ever_muted

boolean

可选

是否被抑制过。是否曾被静默、收敛、抑制过

frequency

enum<string>

可选

触发频率。如果为rare，代表30天内仅发生一次。如果为frequent，代表30天内至少发生20次

枚举值:

rarefrequent

修改于 2025-06-30 06:45:10

评论故障

故障列表