更新时间:2025-07-04 GMT+08:00
分享

事件操作历史列表

功能介绍

查询事件操作历史列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/incidents/{incident_id}/histories

表1 请求path参数列表

名称

类型

是否必选

描述

incident_id

String

参数解释:

事件单号。

约束限制:

字符串

取值范围:

字符长度1-50

默认取值:

不涉及

请求参数

表2 请求Body参数:

名称

类型

是否必选

描述

string_filters

Array of ObjectFilter

参数解释:

条件过滤器。

约束限制:

数组长度:0 - 20

取值范围:

不涉及

默认取值:

不涉及

sort_filter

Array of ObjectFilter

参数解释:

排序过滤器。

约束限制:

数组长度:0 - 10

取值范围:

不涉及

默认取值:

不涉及

condition

String

参数解释:

表达式,对复杂表达式进行组装,可以用英文括号()、与&、或|。

示例:( filterName1 & filterName2) | filterName3。

filterName*:取自string_filters ObjectFilter.name。

如果为空,string_filters中的条件默认是与的关系

约束限制:

字符串

取值范围:

1-10000

默认取值:

不涉及

ObjectFilter参数:

名称

类型

是否必选

描述

name

String

参数解释:

过滤器名称,用于condition表达式拼接。

约束限制:

字符串

取值范围:

0-255

默认取值:

不涉及

field

String

参数解释:

字段KEY,取值参考表4 ListIncidentsResponseBodyData参数列表

约束限制:

字符串

取值范围:

0-255

默认取值:

不涉及

operator

String

参数解释:

操作符,取值:in/like/startwith/endwith/=/!=/>/<。

约束限制:

字符串

取值范围:

0-20

默认取值:

不涉及

values

Arrays of String

参数解释:

需要过滤的值,值的内容支持String,时间戳,枚举,整形,全部以字符串的形式进行传递。

约束限制:

数组长度:1 - 1024

元素字符长度:

最小长度:0

最大长度: 1024

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数列表

名称

类型

是否必选

描述

provider_code

String

参数解释:

服务标识,当前为固定值049。

取值范围:

字符长度0-256

默认取值:

049

error_code

String

参数解释:

请求响应代码,范围:0000~9999,正常时取值:0。

取值范围:

字符长度0-256

默认取值:

0

error_msg

String

参数解释:

请求响应描述。

取值范围:

字符长度0-256

默认取值:

不涉及

data.title

Long

参数解释:

该接口返回的事件单操作记录总条数。

取值范围:

1-9999999999999

默认取值:

不涉及

data.info

Arrays of CocTicketHistoryBaseInfo

参数解释:

历史信息列表。

取值范围:

数组长度:0 - 1024

默认取值:

不涉及

表4 CocTicketHistoryBaseInfo参数列表

名称

类型

是否必选

描述

action

String

参数解释:

Action操作类型。

取值范围:

字符长度0-255

默认取值:

不涉及

action_name_zh

String

参数解释:

Action中文名称。

取值范围:

字符长度0-255

默认取值:

不涉及

action_name_zh

String

参数解释:

Action英文名称。

取值范围:

字符长度0-255

默认取值:

不涉及

operator

String

参数解释:

操作人ID。

取值范围:

字符长度0-255

默认取值:

不涉及

status

String

参数解释:

当前状态。

取值范围:

字符长度0-255

默认取值:

不涉及

start_time

Long

参数解释:

操作开始时间。

取值范围:

1-9999999999999

默认取值:

不涉及

stop_time

Long

参数解释:

操作结束时间。

取值范围:

1-9999999999999

默认取值:

不涉及

comment

String

参数解释:

备注信息。

取值范围:

字符长度0-255

默认取值:

不涉及

enum_data_list

Arrays of TicketInfoEnumData

参数解释:

枚举列表。

取值范围:

数组长度:0 - 1024

默认取值:

不涉及

表5 TicketInfoEnumData参数列表

名称

类型

是否必选

描述

prop_id

String

参数解释:

字段KEY,标识哪个字段。

取值范围:

字符长度0-255

默认取值:

不涉及

biz_id

String

参数解释:

枚举KEY。

取值范围:

字符长度0-255

默认取值:

不涉及

name_zh

String

参数解释:

中文名称。

取值范围:

字符长度0-255

默认取值:

不涉及

name_en

String

参数解释:

英文名称。

取值范围:

字符长度0-255

默认取值:

不涉及

请求示例

获取事件操作历史列表。

POST https://{Endpoint}/v2/incidents/{incident_id}/histories

{
    "sort_filter": {
        "operator": "desc",
        "field": "start_time",
        "name": "start_time",
        "values": [
            "start_time"
        ]
    }
}

响应示例

状态码:200

请求成功。

更多状态码请参考状态码

{
    "provider_code": "049",
    "error_code": "GOM.00000000",
    "error_msg": null,
    "data": {
        "total": 3,
        "info": [
            {
                "action": "incident_accept",
                "operator": "653989085ba7487184d7cf219b8aa51e",
                "start_time": 1744285427529,
                "action_name_zh": "受理事件",
                "action_name_en": "Handling an incident",
                "status": "INCIDENT_STATUS_ACKNOWLEDGED",
                "enum_data_list": [
                    {
                        "name_zh": "COC-Script",
                        "name_en": "COC-Script",
                        "biz_id": "653989085ba7487184d7cf219b8aa51e",
                        "prop_id": "operator"
                    }
                ]
            },
            {
                "action_id": "main",
                "comment": "Create project f****elling. ",
                "start_time": 1744252838982,
                "stop_time": 1744285427529,
                "action_name_zh": "响应预案自动执行失败",
                "action_name_en": "响应预案自动执行失败",
                "status": "INCIDENT_STATUS_TRIGGERED",
                "enum_data_list": [

                ]
            },
            {
                "action": "create_incident",
                "start_time": 1744252838667,
                "stop_time": 1744252838982,
                "action_name_zh": "创建事件单",
                "action_name_en": "create incident",
                "status": "INCIDENT_STATUS_TRIGGERED",
                "enum_data_list": [

                ]
            }
        ]
    }
}

状态码:400

服务器未能处理请求。

更多状态码请参考状态码

{
  "error_code" : "GOM.00007256",
  "error_msg" : "参数错误",
  "provider_code" : "049",
  "data" : null
}

状态码

状态码

描述

200

请求成功。

更多状态码请参考状态码

400

服务器未能处理请求。

更多状态码请参考状态码

错误码

请参见错误码

相关文档