更新时间:2024-05-31 GMT+08:00
分享

查询事件单详情

功能介绍

获取事件单详细

URI

GET /v1/external/incident/{incident_num}

表1 路径参数

参数

是否必选

参数类型

描述

incident_num

String

事件单号

最小长度:0

最大长度:255

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

provider_code

String

服务标识

缺省值:049

最小长度:3

最大长度:100000000

error_code

String

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

缺省值:GOM.00000000

最小长度:1

最大长度:100000000

error_msg

String

请求响应描述

最小长度:0

最大长度:100000000

data

IncidentTicketInfoResponseData object

data

表3 IncidentTicketInfoResponseData

参数

参数类型

描述

incident_num

String

事件单号

最小长度:0

最大长度:255

region

Array of strings

区域Code,如果自动拉起WarRoom则为必填,当前只支持1个

最小长度:0

最大长度:255

数组长度:0 - 1

enterprise_project

Array of strings

企业项目ID,当前只支持1个

最小长度:0

最大长度:255

数组长度:0 - 1

current_cloud_service

Array of strings

归属应用ID,当前只支持1个

最小长度:0

最大长度:255

数组长度:0 - 1

incident_level

String

事件级别 参考:枚举 事件级别incident_level

最小长度:0

最大长度:255

is_service_interrupt

Boolean

业务是否中断,取值:true/false

枚举值:

  • true
  • false

incident_type

String

事件类别 参考:枚举 事件类别incident_type

最小长度:0

最大长度:255

incident_title

String

事件标题,最大长度:200

最小长度:0

最大长度:200

incident_description

String

事件描述,最大长度:600

最小长度:0

最大长度:600

incident_source

String

单据来源 参考:枚举 事件来源incident_source

最小长度:0

最大长度:255

incident_assignee

Array of strings

责任人

最小长度:0

最大长度:255

数组长度:0 - 1

assignee_scene

String

排班场景

最小长度:0

最大长度:255

assignee_role

String

排班角色

最小长度:0

最大长度:255

warroom_id

String

warroom_id

最小长度:0

最大长度:255

handle_time

Long

最后一次提交解决方案时间戳

最小值:1

最大值:9999999999

status

String

状态KEY,参考:枚举 事件状态

最小长度:0

最大长度:255

create_time

Long

创单时间戳

最小值:0

最大值:999999999

creator

String

创单人

最小长度:0

最大长度:255

enum_data_list

Array of TicketInfoEnumData objects

枚举列表

数组长度:0 - 100000000

表4 TicketInfoEnumData

参数

参数类型

描述

filed_key

String

字段KEY 标识哪个字段

最小长度:0

最大长度:255

enum_key

String

枚举KEY

最小长度:0

最大长度:255

name_zh

String

中文名称

最小长度:0

最大长度:255

name_en

String

英文名称

最小长度:0

最大长度:255

状态码: 400

表5 响应Body参数

参数

参数类型

描述

provider_code

String

服务标识

缺省值:049

最小长度:3

最大长度:100000000

error_code

String

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

缺省值:GOM.00000000

最小长度:1

最大长度:100000000

error_msg

String

请求响应描述

最小长度:0

最大长度:100000000

状态码: 200

表6 响应Body参数

参数

参数类型

描述

provider_code

String

服务标识

缺省值:049

最小长度:3

最大长度:100000000

error_code

String

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

缺省值:GOM.00000000

最小长度:1

最大长度:100000000

error_msg

String

请求响应描述

最小长度:0

最大长度:100000000

data

CreateExternalIncidentResponseData object

data

表7 CreateExternalIncidentResponseData

参数

参数类型

描述

incident_num

String

事件单号

最小长度:0

最大长度:255

状态码: 400

表8 响应Body参数

参数

参数类型

描述

provider_code

String

服务标识

缺省值:049

最小长度:3

最大长度:100000000

error_code

String

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

缺省值:GOM.00000000

最小长度:1

最大长度:100000000

error_msg

String

请求响应描述

最小长度:0

最大长度:100000000

请求示例

GET https://IP:PORT/v1/external/incident/IM2024******08
Request Headers:
Content-Type: application/json
X-Auth-Token: MI*******ghkgB

响应示例

{
    "provider_code": "049",
    "error_code": "GOM.00000000",
    "error_msg": null,
    "data": {
        "incident_num": "IM202403181322030178042608",
        "region": [
            ""
        ],
        "enterprise_project": [
            "0"
        ],
        "current_cloud_service": [
            "6470681a31da2a47ed50a919"
        ],
        "incident_level": "level_50",
        "is_service_interrupt": true,
        "incident_type": "inc_type_p_function_issues",
        "incident_title": "tet",
        "incident_description": "25819b46251b46218bf6ad238ddd860c",
        "incident_source": "incident_source_manual",
        "incident_assignee": [
            "25819b46251b46218bf6ad238ddd860c"
        ],
        "assignee_scene": "",
        "assignee_role": "",
        "warroom_id": "WR202403181334366050100030",
        "handle_time": null,
        "status": "INCIDENT_STATUS_ACKNOWLEDGED",
        "create_time": 1710739323172,
        "creator": "1",
        "enum_data_list": [
            {
                "filed_key": "current_cloud_service_id",
                "enum_key": "6470681a31da2a47ed50a919",
                "name_zh": "COC",
                "name_en": "COC"
            },
            {
                "filed_key": "creator",
                "enum_key": "25819b46251b46218bf6ad238ddd860c",
                "name_zh": "coc-cim-user",
                "name_en": "coc-cim-user"
            },
            {
                "filed_key": "level_id",
                "enum_key": "level_50",
                "name_zh": "P5",
                "name_en": "P5"
            },
            {
                "filed_key": "work_flow_status",
                "enum_key": "INCIDENT_STATUS_ACKNOWLEDGED",
                "name_zh": "已受理",
                "name_en": "ACKNOWLEDGED"
            },
            {
                "filed_key": "mtm_type",
                "enum_key": "inc_type_p_function_issues",
                "name_zh": "功能问题",
                "name_en": "function issues"
            },
            {
                "filed_key": "source_id",
                "enum_key": "incident_source_manual",
                "name_zh": "人工创建",
                "name_en": "Manual Creation"
            },
            {
                "filed_key": "assignee",
                "enum_key": "25819b46251b46218bf6ad238ddd860c",
                "name_zh": "coc-cim-user",
                "name_en": "coc-cim-user"
            }
        ]
    }
}

状态码

状态码

描述

200

response

400

Error response

错误码

相关文档