支持用户自主接入告警数据
功能介绍
支持租户将自开发的监控系统按照标准化集成至COC，集成后告警会按照标准格式上报至COC告警中心。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/event/huawei/custom/{integration_key}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
integration_key |
是 |
String |
集成ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
alarmId |
是 |
String |
告警ID。 |
|
alarmName |
是 |
String |
告警名称。 |
|
alarmLevel |
是 |
String |
告警级别。取值为： |
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
provider_code |
String |
服务标识。 |
|
error_code |
String |
请求响应代码，范围：0000~9999，正常时取值：0。 |
|
error_msg |
String |
请求响应描述。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
provider_code |
String |
服务标识。 |
|
error_code |
String |
请求响应代码，范围：0000~9999，正常时取值：0。 |
|
error_msg |
String |
请求响应描述。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
provider_code |
String |
服务标识。 |
|
error_code |
String |
请求响应代码，范围：0000~9999，正常时取值：0。 |
|
error_msg |
String |
请求响应描述。 |
请求示例
自定义消息接入请求体示例
POST 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 |
鉴权有误。 |
错误码
请参见错误码。
