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

处理事件单

功能介绍

事件工单流程功能执行接口，当前仅支持受理/提交事件单解决方案/验证事件处理结果。

调试

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

URI

POST /v1/external/incident/handle

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

incident_num

是

String

事件单号。

最小长度：0

最大长度：255

operator

是

String

操作人ID。

最小长度：0

最大长度：255

operate_key

是

String

操作类型。

最小长度：0

最大长度：255

parameter

否

Map<String,Object>

入参，针对不同场景，入参校验不同，需要的参数key不同

  • 受理，非必填，不传或传null

  • 提交事件单解决方案，必填，额外增加以下字段

    • mtm_type，必填，枚举，事件类别

    • is_service_interrupt，必填，布尔，业务是否中断，取值：true/false

    • cause，必填，字符串，原因，最大长度：10000

    • solution，必填，字符串，解决方案，最大长度：10000

  • 验证事件处理结果，必填，额外增加以下字段

    • virtual_confirm_result，必填，布尔类型，验证结论，取值：true（默认）/false

    • virtual_confirm_comment，必填，字符串，验证说明，最大长度：300

最小长度：0

最大长度：2048

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

provider_code

String

服务标识。

缺省值：049

最小长度：3

最大长度：100000000

error_code

String

请求响应代码，范围：GOM.00000000~GOM.00009999999，正常时取值：GOM.00000000。

缺省值：GOM.00000000

最小长度：1

最大长度：15

error_msg

String

请求响应描述。

最小长度：0

最大长度：100000000

data

Object

执行不同动作后返回信息，当前固定为null

状态码：400

表3 响应Body参数

参数

参数类型

描述

provider_code

String

服务标识。

缺省值：049

最小长度：3

最大长度：100000000

error_code

String

请求响应代码，范围：GOM.00000000~GOM.00009999999，正常时取值：GOM.00000000。

缺省值：GOM.00000000

最小长度：1

最大长度：15

error_msg

String

请求响应描述。

最小长度：0

最大长度：100000000

请求示例

  • 受理事件单。

    https://{Endpoint}/v1/external/incident/handle

{
  "incident_num" : "IM202403221515060171753781",
  "operator" : "7da46971b7e24eed90cf777cc2ff8b91",
  "operate_key" : "acceptedIncident1",
  "parameter" : { }
}

  • 提交事件单解决方案。

    https://{Endpoint}/v1/external/incident/handle

{
  "incident_num" : "IM202403221515060171753781",
  "operator" : "7da46971b7e24eed90cf777cc2ff8b91",
  "operate_key" : "commitSolution1",
  "parameter" : {
    "mtm_type" : "inc_type_p_config_issues",
    "is_service_interrupt" : true,
    "cause" : "100001",
    "solution" : "20001"
  }
}

  • 验证事件处理结果。

    https://{Endpoint}/v1/external/incident/handle

{
  "incident_num" : "IM202403221515060171753781",
  "operator" : "7da46971b7e24eed90cf777cc2ff8b91",
  "operate_key" : "confirm",
  "parameter" : {
    "virtual_confirm_result" : false,
    "virtual_confirm_comment" : "13"
  }
}

响应示例

状态码：200

请求成功。

更多状态码请参考状态码。

{
  "error_code" : "GOM.00000000",
  "error_msg" : null,
  "provider_code" : "049",
  "data" : null
}

状态码：400

服务器未能处理请求。

更多状态码请参考状态码。

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

状态码

状态码

描述

200

请求成功。

更多状态码请参考状态码。

400

服务器未能处理请求。

更多状态码请参考状态码。

错误码

请参见错误码。

父主题： 事件管理

相关文档