事件操作
功能介绍
操作事件接口包括受理，处理（提交解决方案），验证处理结果，以及驳回，升降级，暂停都是通过这个接口完成。
只是不同的操作Action取值不同，以及Param参数不同。与【获取事件任务】接口配合完成，获取taskId。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/incidents/{incident_id}/actions
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
incident_id |
String |
是 |
参数解释： 事件单号。 约束限制： 字符串 取值范围： 字符长度1-50 默认取值： 不涉及 |
请求参数
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
task_id |
String |
是 |
参数解释： 参考Task接口中返回的TaskId。 约束限制： 字符串，长度限制1-100。 取值范围： 不涉及 默认取值： 不涉及 |
|
action |
String |
是 |
参数解释： 标识不同的操作类型。能够执行的操作取决于Task接口返回的TaskOperateKey值。 约束限制： 字符串，长度限制1-100 取值范围：
默认取值： 不涉及 |
|
params |
Map<String,Object> |
否 |
参数解释： 不同的操作（action）对应的参数（Map）及其必填项各不相同。 约束限制： Map类型，详见取值范围。 取值范围：
默认取值： 不涉及 |
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
virtual_schedule_type |
String |
否 |
参数解释： 排班场景。 约束限制： 字符串，长度限制0-255。 排班场景+排班角色和责任人 不可同时为空，全部有值时优先使用责任人。 取值范围： 不涉及 默认取值： 不涉及 |
|
virtual_schedule_role |
String |
否 |
参数解释： 排班角色。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
virtual_send_assignee |
String |
否 |
参数解释： 转发责任人。 约束限制： 字符串，长度限制0-255。责任人为空则排班场景和角色必须非空。 取值范围： 不涉及 默认取值： 不涉及 |
|
virtual_send_comment |
String |
否 |
参数解释： 备注信息。 约束限制： 字符串，长度限制0-300。 取值范围： 不涉及 默认取值： 不涉及 |
|
virtual_current_location_info |
String |
否 |
参数解释： 当前阶段定位情况。 约束限制： 字符串，长度限制0-300。 取值范围： 不涉及 默认取值： 不涉及 |
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
note |
String |
是 |
参数解释： 备注信息。 约束限制： 字符串，长度限制0-300。 取值范围： 不涉及 默认取值： 不涉及 |
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
mtm_type |
String |
是 |
参数解释： 问题类型。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
is_service_interrupt |
Boolean |
是 |
参数解释： 业务是否中断。 约束限制： 不涉及 取值范围： true/false 默认取值： 不涉及 |
|
start_time |
Long |
否 |
参数解释： 故障发生时间，时间戳。 约束限制： 当is_service_interrupt为true时，则为必填。 取值范围： 1-999999999 默认取值： 不涉及 |
|
fault_recovery_time |
Long |
否 |
参数解释： 故障恢复时间，时间戳。 约束限制： 当is_service_interrupt为true时，则为必填。 取值范围： 1-999999999 默认取值： 不涉及 |
|
cause |
String |
否 |
参数解释： 故障原因。 约束限制： 字符串，长度限制0-10000。 取值范围： 不涉及 默认取值： 不涉及 |
|
solution |
String |
否 |
参数解释： 解决方案。 约束限制： 字符串，长度限制0-10000。 取值范围： 不涉及 默认取值： 不涉及 |
|
resolve_attachments |
String |
否 |
参数解释： 附件ID。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
virtual_confirm_result |
Boolean |
是 |
参数解释： 是否解决。 约束限制： 不涉及 取值范围： true/false 默认取值： 不涉及 |
|
virtual_confirm_comment |
String |
是 |
参数解释： 备注信息，事件单审批操作的场景下，需要填写此备注信息。 约束限制： 字符串，长度限制0-300。 取值范围： 不涉及 默认取值： 不涉及 |
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
pause_end_time |
Long |
是 |
参数解释： 暂停截止时间，时间戳。 约束限制： 不涉及 取值范围： 1-999999999 默认取值： 不涉及 |
|
pause_reason |
String |
是 |
参数解释： 暂停原因。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
pause_approve_conclusion |
Boolean |
是 |
参数解释： 是否通过审核，固定取值：true。 约束限制： 不涉及 取值范围： true 默认取值： 不涉及 |
|
note |
String |
是 |
参数解释： 备注信息。 约束限制： 字符串，长度限制0-1024。 取值范围： 不涉及 默认取值： 不涉及 |
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
pause_approve_conclusion |
Boolean |
是 |
参数解释： 是否通过审核，固定取值：false。 约束限制： 不涉及 取值范围： false 默认取值： 不涉及 |
|
note |
String |
是 |
参数解释： 备注信息。 约束限制： 字符串，长度限制0-1024。 取值范围： 不涉及 默认取值： 不涉及 |
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
virtual_target_level |
String |
是 |
参数解释： 目标事件等级。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
virtual_change_level_comment |
String |
是 |
参数解释： 事件单升降级操作过程中添加的备注信息。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
conclusion |
Boolean |
是 |
参数解释： 是否同意，固定取值：true，表示审批同意。 约束限制： 不涉及 取值范围： true 默认取值： 不涉及 |
|
note |
String |
是 |
参数解释： 事件单升降级审批操作过程中添加的备注信息。 约束限制： 字符串，长度限制0-1024。 取值范围： 不涉及 默认取值： 不涉及 |
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
conclusion |
Boolean |
是 |
参数解释： 是否同意，固定取值：false，表示审批驳回。 约束限制： 不涉及 取值范围： false 默认取值： 不涉及 |
|
note |
String |
是 |
参数解释： 备注信息。 约束限制： 字符串，长度限制0-1000。 取值范围： 不涉及 默认取值： 不涉及 |
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
virtual_confirm_comment |
String |
是 |
参数解释： 备注信息。 约束限制： 字符串，长度限制0-300。 取值范围： 不涉及 默认取值： 不涉及 |
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
mtm_region |
String |
否 |
参数解释： Region区域。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
enterprise_project_id |
String |
是 |
参数解释： 事件单绑定的企业项目ID，该信息通过EPS云服务进行查询企业项目列表获取。 约束限制： 当企业项目为default时，值传递0。 取值范围： 不涉及 默认取值： 不涉及 |
|
current_cloud_service_id |
String |
是 |
参数解释： 云服务ID，可通过查询应用接口获取。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
level_id |
String |
是 |
参数解释： 事件等级，参考事件相关枚举信息中的事件级别。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
is_service_interrupt |
Boolean |
是 |
参数解释： 服务是否中断。 约束限制： 不涉及 取值范围： true/false 默认取值： 不涉及 |
|
mtm_type |
String |
否 |
参数解释： 问题类别。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
title |
String |
是 |
参数解释： 标题。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
description |
String |
是 |
参数解释： 描述。 约束限制： 字符串，长度限制0-600。 取值范围： 不涉及 默认取值： 不涉及 |
|
attachments |
String |
否 |
参数解释： 附件ID。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
source_id |
String |
是 |
参数解释： 事件来源，如为手动创建则固定incident_source_manual。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
incident_ownership |
String |
否 |
参数解释： 事件归属。 约束限制： 字符串，长度限制0-255。 取值范围： 不涉及 默认取值： 不涉及 |
|
start_time |
Long |
否 |
参数解释： 故障发生时间。 约束限制： 不涉及。 取值范围： 1-9999999999999 默认取值： 不涉及 |
|
assignee |
String |
否 |
参数解释： 事件处理人。 约束限制： 字符串，长度限制0-255。如果存在事件处理人，则优先使用该处理人。若不存在处理人，则排班场景和角色不可为空。即三个字段不能同时为空。 取值范围： 不涉及 默认取值： 不涉及 |
|
assignee_scene |
String |
否 |
参数解释： 排班场景。 约束限制： 字符串，长度限制0-255。如果存在事件处理人，则优先使用该处理人。若不存在处理人，则排班场景和角色不可为空。即三个字段不能同时为空。 取值范围： 不涉及 默认取值： 不涉及 |
|
assignee_role |
String |
否 |
参数解释： 排班角色。 约束限制： 字符串，长度限制0-255。如果存在事件处理人，则优先使用该处理人。若不存在处理人，则排班场景和角色不可为空。即三个字段不能同时为空。 取值范围： 不涉及 默认取值： 不涉及 |
响应参数
状态码：200
|
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
|
provider_code |
String |
否 |
参数解释： 服务标识。 取值范围： 字符长度0-256 默认取值： 049 |
|
error_code |
String |
否 |
参数解释： 请求响应代码，范围：0000~9999，正常时取值：0。 取值范围： 字符长度0-256 默认取值： 0 |
|
error_msg |
String |
否 |
参数解释： 请求响应描述。 取值范围： 字符长度0-256 默认取值： 不涉及 |
请求示例
- 未受理转发责任人
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "unAcceptedForward",
"params": {
"virtual_send_comment": "备注信息",
"virtual_current_location_info": "定位***",
"virtual_send_assignee": "bae47db0f86c48318ea65f10bd8aa417"
}
}- 受理后转发责任人
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": " acceptedForward",
"params": {
"virtual_send_comment": "备注信息",
"virtual_current_location_info": "定位***",
"virtual_send_assignee": "bae47db0f86c48318ea65f10bd8aa417"
}
}- 受理
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": " accepted"
}- 添加备注
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "addRemark",
"params": {
"note": "备注信息"
}
}- 处理
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "commitSolution",
"params": {
"mtm_type": "inc_type_p_middleware_issues",
"is_service_interrupt": false,
"start_time": null,
"fault_recovery_time": null,
"cause": "222",
"solution": "2222",
"resolve_attachments": ""
}
}- 验证关闭
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "confirm",
"params": {
"virtual_confirm_result": true,
"virtual_confirm_comment": "备注信息"
}
}- 申请暂停事件
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "incidentPause",
"params": {
"pause_end_time": 1744270013000,
"pause_reason": "暂停原因"
}
}- 暂停审批同意
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "agreed",
"params": {
"pause_approve_conclusion": true,
"note": "备注信息"
}
}- 暂停审批驳回
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "rejected",
"params": {
"pause_approve_conclusion": false,
"note": "审批理由"
}
}- 暂停恢复
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": " recovery"
}- 升降级申请
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "changeLevel",
"params": {
"virtual_target_level": "level_30",
"virtual_change_level_comment": "【业务影响】：2\n【升降级理由】：3333"
}
}- 升降级审批同意
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "agreed",
"params": {
"conclusion": true,
"note": "备注信息"
}
}- 升降级审批驳回
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "rejected",
"params": {
"conclusion": false,
"note": "备注信息"
}
}- 未受理驳回
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "rejected",
"params": {
"virtual_confirm_comment": "驳回缘由"
}
}- 驳回重新开启
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "ReOpen",
"params": {
"mtm_region": "br-cto-beta",
"enterprise_project_id": "0",
"current_cloud_service_id": "653f911cfab10c5b1dd33c3a",
"level_id": "level_40",
"is_service_interrupt": true,
"mtm_type": "inc_type_p_monitoring_issues",
"title": "22",
"description": "22",
"attachments": "",
"source_id": "incident_source_manual",
"incident_ownership": "incident_ownership_100",
"start_time": 1743674805160,
"assignee": "bae47db0f86c48318ea65f10bd8aa417",
"assignee_scene": "",
"assignee_role": ""
}
}- 驳回关单
POST https://{Endpoint}/v2/incidents/{incident_id}/action
{
"task_id": "{task_id}",
"action": "agreed"
}响应示例
状态码：200
请求成功。
更多状态码请参考状态码。
{
"provider_code": "049",
"error_code": "GOM.00000000",
"error_msg": null
}状态码：400
服务器未能处理请求。
更多状态码请参考状态码。
{
"error_code" : "GOM.00007256",
"error_msg" : "参数错误",
"provider_code" : "049",
"data" : null
}错误码
请参见错误码。
