文档首页/ 云运维中心 COC/ API参考/ API/ 故障管理/ 告警管理/ 处理告警

更新时间：2025-08-01 GMT+08:00

查看PDF

处理告警

功能介绍

当前可选择应急预案、脚本或作业处理单条告警。通过路径参数alarmID选择单条告警。该接口需要指定执行的应急预案、脚本或作业，详情见请求参数说明和请求示例。

调试

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

URI

POST /v1/alarm-mgmt/alarm/{alarm_id}/auto-process

表1 路径参数
参数	是否必选	参数类型	描述
alarm_id	是	String	参数解释：告警ID，作为一条告警的唯一标识，可从COC控制台告警管理->汇聚告警获取告警ID。约束范围：不涉及取值范围：不涉及默认值：不涉及

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
task_type	是	Object	参数解释：任务类型，处理告警需执行特定的任务，详见取值范围。约束范围：不涉及取值范围： PLAN：应急预案。 SCRIPT：脚本。 RUNBOOK：作业。默认值：不涉及
associated_task_id	是	String	参数解释：任务ID，任务的唯一标识。约束范围：不涉及取值范围：不涉及默认值：不涉及
associated_task_type	是	Object	参数解释：任务类型分类。每个任务有两种分类，分别为自定义任务、公共任务。约束范围：不涉及取值范围： CUSTOMIZATION：自定义。 COMMUNAL：公共。默认值：不涉及
associated_task_name	是	String	参数解释：任务名称。约束范围：不涉及取值范围：不涉及默认值：不涉及
associated_task_enterprise_project_id	否	String	参数解释：企业项目ID。由用户在企业项目管理EPS创建的企业ID。约束范围：不涉及取值范围：不涉及默认值：不涉及
runbook_instance_mode	否	Object	参数解释：作业实例模式。约束范围：请选择告警管理中选择作业后的目标实例模式。取值范围： SAME：步骤一致。 DIFF：步骤独立。 MIXED：自定义。默认值： SAME
input_param	是	Map<String,String>	参数解释：任务执行参数。约束范围：请选择告警管理中选择作业后的目标实例模式。取值范围：长度不超过1000的字符串，格式为json。默认值：不涉及
target_instances	否	Array of ScheduleInstance objects	参数解释：目标实例信息。约束范围：请选择告警管理中选择作业后的目标实例。取值范围：不涉及默认值：不涉及
region_id	否	String	参数解释：区域ID。约束范围：不涉及取值范围：不涉及默认值：不涉及

表3 ScheduleInstance
参数	是否必选	参数类型	描述
target_selection	是	String	参数解释：目标选择方式。约束范围：请选择告警管理中处理告警页面添加实例中的选择方式。取值范围： ALL：所有实例。 MANUAL：手动选择实例。 NONE：无实例。默认值： MANUAL
order_no	是	Integer	参数解释：步骤序号。约束范围：请选择告警管理中处理告警页面作业步骤号，从0开始。取值范围：不涉及默认值：不涉及
batch_strategy	否	String	参数解释：分批策略。用户可选择分批策略，控制实例的执行规模。约束范围：请选择告警管理中处理告警页面的分批策略。取值范围： AUTO_BATCH：自动分批。 MANUAL_BATCH：手动分批。 NONE：不分批。默认值：不涉及
sub_target_instances	否	Array of ScheduleInstance objects	参数解释：子步骤实例目标。任务子步骤中，用户亦可以执行某些实例。约束范围：不涉及取值范围：不涉及默认值：不涉及

响应参数

状态码：200

正确响应

状态码：400

表4 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

使用应急源处理告警ID为‘ALM2025071417361705s6mUUrF’的告警。

POST https://{Endpoint}/v1/alarm-mgmt/alarm/ALM2025071417361705s6mUUrF/auto-process

{
  "task_type" : "PLAN",
  "associated_task_type" : "CUSTOMIZATION",
  "associated_task_id" : "CTP20250705005804610013656",
  "associated_task_enterprise_project_id" : "0",
  "associated_task_name" : "test-v5",
  "input_param" : {
    "success_rate" : 100,
    "timeout" : 300,
    "execute_user" : "root",
    "project_id" : "****",
    "script_params" : "[{\"paramName\":\"aaa\",\"paramValue\":\"1\",\"paramOrder\":1}]"
  },
  "target_instances" : [ {
    "target_selection" : "MANUAL",
    "target_instances" : "{\"batches\":[{\"batchIndex\":1,\"rotationStrategy\":\"CONTINUE\",\"targetInstances\":[{\"resourceId\":\"****\",\"regionId\":\"cn-north-4\",\"provider\":\"ECS\",\"type\":\"CLOUDSERVERS\",\"agentSn\":\"****\",\"agentStatus\":\"ONLINE\",\"nodeId\":\"\",\"enterpriseProjectId\":\"0\",\"properties\":{\"hostName\":\"platform04-l60076595\",\"fixedIp\":\"192.168.0.50\",\"regionId\":\"cn-north-4\",\"zoneId\":\"cn-north-4a\",\"projectId\":\"****\"}}],\"cmdbInstances\":[{\"id\":\"****\",\"resourceId\":\"****\",\"name\":\"platform04-l60076595\",\"projectId\":\"****\",\"domainId\":\"****\",\"regionId\":\"cn-north-4\",\"agentId\":\"****\",\"agentState\":\"ONLINE\",\"provider\":\"ecs\",\"enterpriseProjectId\":\"0\",\"type\":\"cloudservers\",\"properties\":{\"addresses\":[{\"OsExtIpsType\":\"fixed\",\"OsExtIpsPortId\":\"055f2d75-f3fc-439a-8958-e7bc0b75cb9f\",\"addr\":\"192.168.0.50\",\"version\":4,\"OsExtIpsMacAddr\":\"fa:16:3e:fa:52:84\",\"primary\":true}],\"metadata\":{\"osType\":\"Linux\"},\"OsExtAz\":\"cn-north-4a\",\"status\":\"SHUTOFF\"}}]}],\"policy\":\"none\",\"all_rotation\":\"FIRST_PAUSE\"}",
    "order_no" : 0,
    "batch_strategy" : "NONE"
  } ],
  "runbook_instance_mode" : "SAME",
  "sub_task_info" : {
    "sub_task_type" : "SCRIPT",
    "sub_associated_task_id" : "SC202507042240130195716f7",
    "sub_associated_task_name" : "yy-ccc",
    "sub_associated_task_type" : "CUSTOMIZATION"
  }
}

使用脚本处理告警ID为‘ALM2025071417361705s6mUUrF’的告警。

POST https://{Endpoint}/v1/alarm-mgmt/alarm/ALM2025071417361705s6mUUrF/auto-process

{
  "task_type" : "SCRIPT",
  "associated_task_type" : "CUSTOMIZATION",
  "associated_task_id" : "SC2025071006154101b779eb7",
  "associated_task_enterprise_project_id" : "0",
  "associated_task_name" : "testScript92DDf",
  "input_param" : {
    "timeout" : 300,
    "execute_user" : "root",
    "success_rate" : 100,
    "project_id" : "****",
    "script_params" : "[]"
  },
  "target_instances" : [ {
    "target_selection" : "MANUAL",
    "target_instances" : "{\"batches\":[{\"batchIndex\":1,\"rotationStrategy\":\"CONTINUE\",\"targetInstances\":[{\"resourceId\":\"****\",\"regionId\":\"cn-north-4\",\"provider\":\"ECS\",\"type\":\"CLOUDSERVERS\",\"agentSn\":\"****\",\"agentStatus\":\"ONLINE\",\"nodeId\":\"\",\"enterpriseProjectId\":\"0\",\"properties\":{\"hostName\":\"platform04-l60076595\",\"fixedIp\":\"192.168.0.50\",\"regionId\":\"cn-north-4\",\"zoneId\":\"cn-north-4a\",\"projectId\":\"****\"}}],\"cmdbInstances\":[{\"id\":\"****\",\"resourceId\":\"****\",\"name\":\"platform04-l60076595\",\"projectId\":\"****\",\"domainId\":\"****\",\"regionId\":\"cn-north-4\",\"agentId\":\"****\",\"agentState\":\"ONLINE\",\"provider\":\"ecs\",\"enterpriseProjectId\":\"0\",\"type\":\"cloudservers\",\"properties\":{\"addresses\":[{\"OsExtIpsType\":\"fixed\",\"OsExtIpsPortId\":\"055f2d75-f3fc-439a-8958-e7bc0b75cb9f\",\"addr\":\"192.168.0.50\",\"version\":4,\"OsExtIpsMacAddr\":\"fa:16:3e:fa:52:84\",\"primary\":true}],\"metadata\":{\"osType\":\"Linux\"},\"OsExtAz\":\"cn-north-4a\",\"status\":\"ACTIVE\"}}]}],\"policy\":\"none\",\"all_rotation\":\"FIRST_PAUSE\"}",
    "order_no" : 0,
    "batch_strategy" : "NONE"
  } ],
  "runbook_instance_mode" : "SAME",
  "sub_task_info" : null
}

使用作业处理告警id为‘ALM2025071417361705s6mUUrF’的告警。

POST https://{Endpoint}/v1/alarm-mgmt/alarm/ALM2025071417361705s6mUUrF/auto-process

{
  "task_type" : "RUNBOOK",
  "associated_task_type" : "CUSTOMIZATION",
  "associated_task_id" : "RB2025070814434301497f304",
  "associated_task_enterprise_project_id" : "0",
  "associated_task_name" : "listinstance",
  "associated_task_name_en" : "",
  "input_param" : {
    "success_rate" : 100,
    "project_id" : "****",
    "job_uuid" : "RB2025070814434301497f304",
    "execute_atomic_tasks" : "[{\"accountmgmt_changepwd_task\":false,\"task_name\":\"listinstance\",\"task_name_en\":null,\"task_desc\":null,\"task_desc_en\":null,\"atomic_unique_key\":\"execute_api\",\"type\":\"Simple\",\"sub_tasks\":[{\"accountmgmt_changepwd_task\":false,\"task_name\":\"listinstance\",\"task_name_en\":null,\"task_desc\":null,\"task_desc_en\":null,\"atomic_unique_key\":\"execute_api\",\"type\":\"Simple\",\"sub_tasks\":[],\"inputs\":[{\"param_key\":\"service\",\"param_value\":\"Kafka\",\"value_type\":\"CUSTOM\",\"atomic_name\":null},{\"param_key\":\"apiName\",\"param_value\":\"ListInstances\",\"value_type\":\"CUSTOM\",\"atomic_name\":null},{\"param_key\":\"path\",\"param_value\":{},\"value_type\":\"COMPLEX\",\"atomic_name\":null},{\"param_key\":\"query\",\"param_value\":{\"engine\":\"kafka\",\"name\":null,\"instance_id\":\"****\",\"status\":null,\"include_failure\":null,\"exact_match_name\":null,\"enterprise_project_id\":null,\"offset\":null,\"limit\":null},\"value_type\":\"COMPLEX\",\"atomic_name\":null},{\"param_key\":\"body\",\"param_value\":{},\"value_type\":\"COMPLEX\",\"atomic_name\":null}],\"outputs\":[],\"display_region\":\"REQUIRED\",\"error_handle_type\":\"STOP\",\"execute_batches\":[],\"loop_instances\":[],\"target_instance\":{\"limit\":999,\"required\":false},\"loop_item\":null,\"label\":\"1. listinstance\",\"default_filter_params\":{\"agent_state\":\"ONLINE\"},\"checked_instance\":[]}],\"inputs\":[{\"param_key\":\"service\",\"param_value\":\"Kafka\",\"value_type\":\"CUSTOM\",\"atomic_name\":null},{\"param_key\":\"apiName\",\"param_value\":\"ListInstances\",\"value_type\":\"CUSTOM\",\"atomic_name\":null},{\"param_key\":\"path\",\"param_value\":{},\"value_type\":\"COMPLEX\",\"atomic_name\":null},{\"param_key\":\"query\",\"param_value\":{\"engine\":\"kafka\",\"name\":null,\"instance_id\":\"****\",\"status\":null,\"include_failure\":null,\"exact_match_name\":null,\"enterprise_project_id\":null,\"offset\":null,\"limit\":null},\"value_type\":\"COMPLEX\",\"atomic_name\":null},{\"param_key\":\"body\",\"param_value\":{},\"value_type\":\"COMPLEX\",\"atomic_name\":null}],\"outputs\":[],\"display_region\":\"REQUIRED\",\"error_handle_type\":\"STOP\",\"execute_batches\":[],\"loop_instances\":[],\"target_instance\":{\"limit\":999,\"required\":false},\"loop_item\":null,\"label\":\"1. listinstance\",\"step_same_active\":true,\"step_diff_active\":true}]",
    "vars" : "[]"
  },
  "target_instances" : [ {
    "target_selection" : "NONE",
    "target_resource" : null,
    "order_no" : 0,
    "batch_strategy" : null,
    "sub_target_instances" : [ {
      "target_selection" : "NONE",
      "target_resource" : null,
      "target_instances" : null,
      "order_no" : 0,
      "batch_strategy" : null
    } ]
  } ],
  "runbook_instance_mode" : "DIFF",
  "instance_required" : false,
  "sub_task_info" : null,
  "region_id" : "cn-north-4"
}

响应示例

状态码：200

正确响应

{
  "errorCode" : "200",
  "errorMsg" : "Success",
  "data" : "RBT2025071417373701226d25c"
}

状态码

状态码	描述
200	正确响应
400	客户端请求错误响应。

错误码

请参见错误码。

父主题： 告警管理

上一篇：告警管理

下一篇：查询告警详情

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问