CloudOS物理设备告警通知

openid

必选

请求头参数列表

String

会话标识，用于Open API的鉴权。

systemID

必选

请求实体参数列表

String

第三方系统标识。

openID

必选

请求实体参数列表

String

网管主动连接第三方系统的认证凭证，由第三方系统分配和利用此字符串认证。

url

必选

请求实体参数列表

String

网管以 POST 方式向该 URL发送通知消息。

dataType

可选

请求实体参数列表

String

通知报文的 data 字段类型。

desc

可选

请求实体参数列表

String

第三方系统描述。

code

int

操作返回码。可以是如下值之一：

• 0：成功
• 非0：失败。其中 1001 表示 license 无效；1002 表示 license 不具有调用 OpenAPI 的功能；1204 表示认证失败；1501 表示 systemID 未给出；1502表示 systemID 不合法；1503 表示第三方系统认证凭证 openID 未提供；1504 表示第三方系统认证凭证 openID 不合法；1505 表示 dataType 不支持；1506 表示第三方系统消息接收 URL 未提供；1507 表示第三方系统消息接收 URL 不合法；1508 表示第三方系统消息接收 URL 不在 OpenAPI 白名单中；1509 表示虽然提供了描述信息但不合法；1510 表示请求的 resourceURI 不存在（即整个请求地址对应资源不存在）；1511 表示请求地址无效而导致订阅无效。

data

String

此处为 null。

description

String

接口调用结果的描述信息。

请求 URL

PUT https://eSightIP: port/rest/openapi/notification/server/hwalarm/risk HTTP/1.1

请求头

openid: 775c47f9-9a1b-43f9-a24b-2c3db1a55622;

请求实体

systemID=example%40system&openID=1b7a6992-5d5f-4091-a49f-ec2e09640a05&url=https%3A%2F%2FdemoIP%3AdemoPort%2Fnotification&dataType=JSON&desc=eSight+DesignIn+Demo

响应实体

{"code":0,"data":null,"description":"Operation success."}

openid

必选

消息头参数列表

String

会话标识，用于Open API的鉴权。

systemID

必选

URL 参数列表

String

第三方系统标识。

desc

可选

URL 参数列表

String

三方系统描述。

code

int

操作返回码。可以是如下值之一：

• 0：成功
• 非0：失败。其中 1001 表示 license 无效；1002 表示 license 不具有调用 OpenAPI 的功能；1204 表示认证失败；1501 表示 systemID 未给出；1502表示 systemID 不合法；1512 表示请求地址无效而导致退订无效。

data

String

此处为 null。

description

String

接口调用结果的描述信息。

请求 URL

DELETE https://eSightIP:port/rest/openapi/notification/server/hwalarm/risk?systemID=example%40system&desc=eSight+DesignIn+Demo+Unsubscription. HTTP/1.1

请求头

openid: 775c47f9-9a1b-43f9-a24b-2c3db1a55622;

请求实体

N/A

响应实体

{"code":0,"data":null,"description":"Operation success."}

resourceURI

String

资源类型 URI，与订阅消息的URI定义一致，该变更通知固定为“/rest/openapi/notification/server/hwalarm/risk”字符串。

msgType

int

消息类型。取值范围：

• 0：风险发生
• 1：风险解除

data

list

以 JSON 数组形式描述的数据对象。告警相关数据的结构,参见下面定义

说明：

如果消息接收地址为 HTTP 协议，则 data 的值为加密字符串，需要第三方系统根据配置文件中的 KEY 和 IV 值解密，之后再解析数据对象。

extendedData

String

以字符串表示的 JSON 附加数据对象，此处为空对象 “{}”。

description

String

消息通知描述。

timestamp

String

消息发出的时间戳，eSight 服务器协调时间格式。

rackDn

String

机架DN

rackIP

String

机架地址bmcIP地址

deviceDn

String

刀片DN

deviceIndex

String

刀片的槽位号

deviceBMCIP

String

刀片的BMC管理地址

hostIP

String

主机在openstack资源池的管理地址

hostId

String

主机Id

hostName

String

主机名称

virtualType

int

主机虚拟化类型：

• 1：KVM
• 2：Ironic
• 3：FusionCompute
• 4：vCenter

platformDn

String

云平台dn

platformDomain

String

云平台域名(FusionSphere是域名，其他是IP)

platformType

int

云平台类型：

• 1：ESXi
• 3：FusionComputer
• 4：vCenter
• 5：FusionSphere

alarmGroupID

String

告警组id

alarmCode

String

告警码id

alarmName

String

告警名称

alarmLevel

String

告警级别。可以是如下值之一：

• 0：不确定
• 1：紧急
• 2：重要
• 3：次要
• 4：提示
• 5：已清除

eventTime

String

告警首次发生时间

isClear

int

清除类型：

• 0：未清除
• 1：清除

alarmLocation

String

告警位置

request.getParameter("resourceURI")

"/rest/openapi/notification/server/hwalarm/risk"

request.getParameter("msgType")

1

request.getParameter("data")

"[{

\"rackDn\": \"NE=34603009\",

\"rackIP\":\"192.168.11.20\",

\"deviceDn\": \"NE=34605715\",

\"deviceIndex\": \"10\",

\"deviceBMCIP\": \"192.168.13.20\",

\"hostIP\": \"10.10.10.1\",

\"hostId\": \"host1\",

\"hostName\": \"host1\",

\"platformDn\": \"NE=34603110\",

\"platformDomain\": \"h.h.com\",

\"virtualType\": 0,

\"platformType\": 1,

\"alarmGroupID\": \"278413609\",

\"alarmCode\": \"117506047\",

\"alarmName\": \"test=\",

\"alarmLevel\": \"2\",

\"eventTime\": \"1480153460709\",

\"isClear\": 0,

\"alarmLocation\": \",部件=blade10\"

}]"

request.getParameter("description")

""

request.getParameter("timestamp")

"2016-11-26 17:44:20"

request.getParameter("extendedData")

"{}"