文档首页/ 云运维中心 COC/ API参考/ API/ 故障管理/ 集成管理
更新时间：2024-07-25 GMT+08:00
查看PDF
分享

集成管理

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

功能介绍

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

integration_key

是

String

集成ID

最小长度：1

最大长度：255

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

alarmId

是

String

告警id

最小长度：1

最大长度：255

alarmName

是

String

告警名称

最小长度：1

最大长度：255

alarmLevel

是

String

告警级别。取值为Critical（紧急）, Major（重要）, Minor（次要）, Info（提示）

最小长度：1

最大长度：255

枚举值：

  • Critical
  • Major
  • Minor
  • Info

time

是

Long

告警发生时间

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（已恢复）

最小长度：0

最大长度：255

枚举值：

  • alarm
  • ok

alarmSource

是

String

告警源

最小长度：1

最大长度：255

additional

否

Object

告警附加信息

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

provider_code

String

服务标识

缺省值：049

最小长度：0

最大长度：256

error_code

String

请求响应代码，范围：0000~9999，正常时取值：0

缺省值：0

最小长度：0

最大长度：256

error_msg

String

请求响应描述

最小长度：0

最大长度：256

请求示例

https://coc.myhuaweicloud.com/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://example.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

鉴权有误
父主题： 故障管理

相关文档