文档首页/ 云运维中心 COC/ API参考/ API/ 故障管理/ 事件管理/ 创建事件单
更新时间：2024-06-06 GMT+08:00
查看PDF
分享

创建事件单

功能介绍

创建事件单

URI

POST /v1/external/incident/create

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

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

creator

是

String

创单人

最小长度：0

最大长度：255

incident_assignee（责任人）和assignee_scene（排班场景）、assignee_role（排班角色）必须填写其中一个。如果填写了incident_assignee，可不用填写assignee_scene和assignee_role，assignee_scene和assignee_role是捆绑在一起的。

响应参数

状态码： 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

CreateExternalIncidentResponseData object

data
表3 CreateExternalIncidentResponseData

参数

参数类型

描述

incident_num

String

事件单号

最小长度：0

最大长度：255

状态码： 400

表4 响应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/create
Request Headers:
Content-Type: application/json
X-Auth-Token: MI*******ghkgB
Request Body:
{
    "region": [
        "cn-southwest-252"
    ],
    "enterprise_project": [
        "ab080d9f-6b97-4e73-8679-b6d76057f274"
    ],
    "current_cloud_service": [
        "65659ae2f42bf80e5f3f0635"
    ],
    "incident_level": "level_50",
    "is_service_interrupt": "true",
    "incident_type": "inc_type_p_security_issues",
    "incident_title": "测试时间单号10001",
    "incident_description": "测试时间单号10001",
    "incident_source": "incident_source_manual",
    "incident_assignee": ["7da46971b7e24eed90cf777cc2ff8b91"],
    "creator": "7da46971b7e24eed90cf777cc2ff8b91",
    "assignee_scene": "",
    "assignee_role": ""
}

响应示例

{
    "provider_code": "049",
    "error_code": "GOM.00000000",
    "error_msg": null,
    "data": {
        "incident_num": "IM202403221515060171753781"
    }
}
父主题： 事件管理