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

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

功能介绍

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

调试

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

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

integration_key

String

集成ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

alarmId

String

告警id。

alarmName

String

告警名称。

alarmLevel

String

告警级别。取值为:

  • Critical(紧急)

  • Major(重要)

  • inor(次要)

  • Info(提示)

time

Long

告警发生时间。

nameSpace

String

服务的命名空间。

regionId

String

告警发生区域。

applicationId

String

应用id

resourceName

String

资源名称。

resourceId

String

资源ID。

alarmDesc

String

告警描述。

URL

String

原始告警URL。

alarmStatus

String

告警状态。一般取值为:

  • alarm(告警中)

  • ok(已恢复)

alarmSource

String

告警源。

additional

Object

告警附加信息。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

provider_code

String

服务标识。

error_code

String

请求响应代码,范围:0000~9999,正常时取值:0。

error_msg

String

请求响应描述。

状态码:400

表4 响应Body参数

参数

参数类型

描述

provider_code

String

服务标识。

error_code

String

请求响应代码,范围:0000~9999,正常时取值:0。

error_msg

String

请求响应描述。

状态码:401

表5 响应Body参数

参数

参数类型

描述

provider_code

String

服务标识。

error_code

String

请求响应代码,范围:0000~9999,正常时取值:0。

error_msg

String

请求响应描述。

请求示例

自定义消息接入请求体示例

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

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

响应示例

状态码:200

请求成功。

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

状态码:400

请求体有误。

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

状态码:401

鉴权有误。

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

状态码

状态码

描述

200

请求成功。

400

请求体有误。

401

鉴权有误。

错误码

请参见错误码

相关文档