处理事件单 - HandleCocIncident
功能介绍
事件工单流程功能执行接口，当前仅支持受理/提交事件单解决方案/验证事件处理结果。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
coc:ticket:action
Write
-
-
-
-
URI
POST /v1/external/incident/handle
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| incident_num | 是 | String | 参数解释： 需要处理的事件单单号。 约束限制： 字符串 0 - 255字符 取值范围： 不涉及 默认取值： 不涉及 |
| operator | 是 | String | 参数解释： 操作人Id。 约束限制： 字符串 0 - 255字符 取值范围： 不涉及 默认取值： 不涉及 |
| operate_key | 是 | String | 参数解释： 需要对事件单进行的操作类型，枚举值。 约束限制： 字符串 0 - 255字符 取值范围： 枚举值： 默认取值： 不涉及 |
| parameter | 否 | Map<String,Object> | 入参，针对不同场景，入参校验不同，需要的参数key不同 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| provider_code | String | 参数解释： 服务标识。 取值范围： 不涉及 默认取值： 049 |
| error_code | String | 参数解释： 请求响应代码。 取值范围： GOM.00000000~GOM.00009999999 默认取值： GOM.00000000 |
| error_msg | String | 参数解释： 请求响应描述。 取值范围： 不涉及 |
| data | Object | 执行不同动作后返回信息，当前固定为null |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| provider_code | String | 参数解释： 服务标识。 取值范围： 不涉及 默认取值： 049 |
| error_code | String | 参数解释： 请求响应代码。 取值范围： GOM.00000000~GOM.00009999999 默认取值： GOM.00000000 |
| error_msg | String | 参数解释： 请求响应描述。 取值范围： 不涉及 |
请求示例
-
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" : 4,
"data" : null
} 状态码：400
服务器未能处理请求。
更多状态码请参考状态码。
{
"error_code" : "GOM.00007256",
"error_msg" : "参数错误",
"provider_code" : 4,
"data" : null
} 错误码
请参见错误码。
