文档首页/ 云运维中心 COC/ API参考/ API/ 故障管理/ 流转规则/ 支持用户自主接入告警数据 - ReportCustomEvent
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

支持用户自主接入告警数据 - ReportCustomEvent

功能介绍

支持租户将自开发的监控系统按照标准化集成到COC，集成后告警会按照标准格式上报至COC告警中心。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v1/event/huawei/custom/{integration_key}

表1 路径参数

参数

是否必选

参数类型

描述

integration_key

是

String

参数解释：

集成ID。

约束限制：

从COC集成管理界面获取，每个接入源的集成ID唯一。

取值范围：

由字母、数字组成，长度为32位。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

alarmId

是

String

参数解释：

告警ID，每条告警的唯一标识。

约束限制：

不涉及。

取值范围：

由字母、数字组成，长度在1~255之间。

默认取值：

不涉及。

alarmName

是

String

参数解释：

告警名称。

约束限制：

不涉及。

取值范围：

由中文、字母、数字、中划线、下划线组成，长度在1~255之间。

默认取值：

不涉及。

alarmLevel

是

String

参数解释：

告警级别。

约束限制：

不涉及。

取值范围：

  • Critical：紧急。

  • Major：重要。

  • Minor：次要。

  • Info：提示。

默认取值：

不涉及。

time

是

Long

参数解释：

告警发生时间。

约束限制：

不涉及。

取值范围：

时间戳，长度为1~9223372036854775807。

默认取值：

不涉及。

nameSpace

是

String

参数解释：

命名空间。

约束限制：

不涉及。

取值范围：

长度为1~255。

默认取值：

不涉及。

regionId

否

String

参数解释：

告警发生区域。

约束限制：

不涉及。

取值范围：

长度为0~255。

默认取值：

不涉及。

applicationId

否

String

参数解释：

应用ID。

约束限制：

不涉及。

取值范围：

长度为1~255。

默认取值：

不涉及。

resourceName

否

String

参数解释：

资源名称。

约束限制：

不涉及。

取值范围：

长度为0~255。

默认取值：

不涉及。

resourceId

否

String

参数解释：

资源ID。

约束限制：

不涉及。

取值范围：

长度为0~255。

默认取值：

不涉及。

alarmDesc

是

String

参数解释：

告警描述。

约束限制：

不涉及。

取值范围：

长度为1~255。

默认取值：

不涉及。

URL

否

String

参数解释：

原始告警URL。

约束限制：

不涉及。

取值范围：

长度为0~255。

默认取值：

不涉及。

alarmStatus

否

String

参数解释：

告警状态。

约束限制：

不涉及。

取值范围：

  • alarm：告警中。

  • ok：已恢复。

默认取值：

不涉及。

alarmSource

是

String

参数解释：

告警源。

约束限制：

不涉及。

取值范围：

长度为1~255。

默认取值：

不涉及。

additional

否

Object

参数解释：

告警附加信息。

约束限制：

不涉及。

取值范围：

长度为1~4096。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

provider_code

String

参数解释：

服务标识。

取值范围：

长度为0~256。

error_code

String

参数解释：

请求响应代码。

取值范围：

0000~9999，正常时取值：0。

error_msg

String

参数解释：

请求响应描述。

取值范围：

长度0~256。

状态码：400

表4 响应Body参数

参数

参数类型

描述

provider_code

String

参数解释：

服务标识。

取值范围：

长度为0~256。

error_code

String

参数解释：

请求响应代码。

取值范围：

0000~9999，正常时取值：0。

error_msg

String

参数解释：

请求响应描述。

取值范围：

长度0~256。

状态码：401

表5 响应Body参数

参数

参数类型

描述

provider_code

String

参数解释：

服务标识。

取值范围：

长度为0~256。

error_code

String

参数解释：

请求响应代码。

取值范围：

0000~9999，正常时取值：0。

error_msg

String

参数解释：

请求响应描述。

取值范围：

长度0~256。

请求示例

自定义告警源消息接入请求体示例。

POST https://{Endpoint}/v1/event/huawei/custom/{integration_key}

{
  "alarmId" : "18cfxxxxxxxxxx0f8",
  "alarmName" : "Cpu 使用超额预警",
  "alarmLevel" : "Critical",
  "time" : 1709118444540,
  "nameSpace" : "shanghai",
  "regionId" : "cn-north-4",
  "applicationId" : "18xxxxxxxx8d",
  "resourceName" : "machine-1",
  "resourceId" : "18cxxxxxxxxxxxxff68625",
  "alarmDesc" : "string",
  "URL" : "https://xxx.com",
  "alarmStatus" : "alarm",
  "alarmSource" : "coc",
  "additional" : { }
}

响应示例

状态码：200

接入成功。

{
  "error_code" : "COC.00000000",
  "error_msg" : "success",
  "provider_code" : "049"
}

状态码：400

请求体有误。

{
  "error_code" : "COC.00000001",
  "error_msg" : "alarmName must not be null | alarmId must not be null",
  "provider_code" : "049"
}

状态码：401

鉴权有误。

{
  "error_code" : "common.01010001",
  "error_msg" : "Token missing or invalid.",
  "provider_code" : "049"
}

状态码

状态码

描述

200

接入成功。

400

请求体有误。

401

鉴权有误。

错误码

请参见错误码。

父主题： 流转规则