Flashcat API

故障明细查询

POST

https://api.flashcat.cloud/insight/incident/list

最后修改时间：2025-01-08 02:51:56

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.flashcat.cloud/insight/incident/list?app_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start_time": 0,
    "end_time": 0,
    "team_ids": [
        0
    ],
    "is_my_team": true,
    "channel_ids": [
        0
    ],
    "severities": [
        "Info"
    ],
    "time_zone": "Asia/Shanghai",
    "asc": true,
    "orderby": "created_at",
    "search_after_ctx": "string",
    "p": 1,
    "limit": 20
}'

响应示例

{
    "error": {
        "code": "InvalidParameter",
        "message": "string"
    },
    "data": {
        "items": [
            {
                "incident_id": "string",
                "title": "string",
                "team_id": 0,
                "team_name": "string",
                "channel_id": 0,
                "channel_name": "string",
                "progress": "Triggered",
                "severity": "Info",
                "created_at": 0,
                "closed_by": "timeout",
                "seconds_to_ack": 0,
                "seconds_to_close": 0,
                "engaged_seconds": 0,
                "hours": "work",
                "notifications": 0,
                "interruptions": 0,
                "assignments": 0,
                "reassignments": 0,
                "acknowledgements": 0,
                "escalations": 0,
                "manual_escalations": 0,
                "timeout_escalations": 0,
                "responders": [
                    {
                        "person_id": 0,
                        "assigned_at": 0,
                        "acknowledged_at": 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"
                }
            }
        ],
        "search_after_ctx": "string",
        "total": 0,
        "has_next_page": true
    }
}

请求参数

Authorization

在 query 添加参数

app_key

示例：

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

Body 参数application/json

start_time

integer

开始时间

必需

秒时间戳，故障的触发时间需大于此时间

end_time

integer

结束时间

必需

秒时间戳，故障的触发时间需小于等于此时间。最大时间跨度6个月，若aggregate_unit聚合粒度为day，则最大时间跨度6个月

team_ids

array[integer]

团队列表

可选

团队列表，与is_my_team同时传入时，取交集。

is_my_team

boolean

我的团队

可选

与team_ids同时传入时，取交集。

channel_ids

array[integer]

协作空间列表

可选

空间列表，仅可选择您可见的空间

severities

array[string]

严重程度

可选

严重程度

枚举值:

InfoWarningCritical

time_zone

string

时区

可选

默认时区 Asia/Shanghai，用于结果和分组的时区。必须是 tzdata 格式。请参阅此处可接受的值列表。

默认值:

Asia/Shanghai

asc

boolean

是否升序

可选

orderby

enum<string>

排序字段

可选

仅支持故障触发时间created_at

枚举值:

created_at

search_after_ctx

string

游标分页，不设置为第一页。与p参数二选一

可选

详细解释，请参考关于分页

integer

传统分页，不设置从第一页开始，默认值为1，与search_after_ctx参数二选一

可选

基于传统分页时设置，当设置p参数时，p*limit不得超过10000，否则返回参数错误。详细解释，请参考关于分页

默认值:

limit

integer

分页条数

可选

当设置p参数时，(p-1)*limit不得超过10000，否则返回参数错误。详细解释，请参考关于分页

>= 0<= 100

默认值:

示例

返回响应

🟢200成功

application/json

Body

error

object (DutyError)

可选

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

data

object

可选

items

array [object {24}]

故障列表

必需

search_after_ctx