IT设备链路变更消息
订阅IT链路变更通知
接口功能
订阅IT设备链路变更通知接口。
URI路径
/rest/openapi/notification/it/link
访问方法
PUT
参数说明
参数名 |
必选/可选 |
参数位置 |
参数类型 |
参数说明 |
|---|---|---|---|---|
openid |
必选 |
请求头参数列表 |
String |
会话标识，用于Open API的鉴权。 说明：
该参数由第三方调用安全管理登录接口获取openid。 |
systemID |
必选 |
请求实体参数列表 |
String |
第三方系统标识。 说明：
可为IP地址，1~64个字符，字符集合为英文半角：0-9a-zA-Z@_-(),.^$~`! |
openID |
必选 |
请求实体参数列表 |
String |
网管主动连接第三方系统的认证凭证，由第三方系统分配和利用此字符串认证。 说明：
1~1024个字符，字符集同 systemID。 |
url |
必选 |
请求实体参数列表 |
String |
网管以 POST 方式向该 URL发送通知消息。 说明：
例如 http://10.10.10.10:8080/device。需要通知消息订阅者确保URL的正确性，IP地址为OpenAPI白名单列表中地址。长度1~1024，字符串符合HTTP URL编码规范。 |
dataType |
可选 |
请求实体参数列表 |
String |
通知报文的 data 字段类型。 说明：
目前仅支持“JSON”，缺省为“JSON”。 |
desc |
可选 |
请求实体参数列表 |
String |
第三方系统描述。 说明：
缺省为null 不设置。如设置长度限制0~1024字符，字符集合不限制。 |
返回结果
字段名 |
类型 |
说明 |
|---|---|---|
code |
int |
操作返回码。可以是如下值之一：
|
data |
List |
此处为null |
description |
String |
接口调用结果的描述信息。 |
注意事项
无。
取消订阅IT设备链路变更通知
接口功能
取消订阅IT设备链路变更通知的接口。
URI路径
/rest/openapi/notification/it/link
访问方法
DELETE
参数说明
参数名 |
必选/可选 |
参数位置 |
参数类型 |
参数说明 |
|---|---|---|---|---|
systemID |
必选 |
参数列表 |
String |
第三方系统标识（可为IP地址） |
desc |
可选 |
参数列表 |
String |
第三方系统描述 |
返回结果
字段名 |
类型 |
说明 |
|---|---|---|
code |
int |
操作返回码。可以是如下值之一：
|
data |
List |
此处为null |
description |
String |
接口调用结果的描述信息。 |
注意事项
无。
IT链路变更通知的数据结构
消息数据
字段名 |
条件 |
类型 |
说明 |
|---|---|---|---|
msgType |
必选 |
int |
必选，消息类型，枚举数值。可以是如下值之一：
|
resourceURI |
必选 |
String |
“/rest/openapi/notification/it/link”。 |
moduleID |
必选 |
String |
模块ID，对于IT枚举如下： “com.huawei.it.link.notification” |
dataObjectJson |
必选 |
String |
数据内容，为一个JSON 化的对象，此处应当link信息。 |
utcTimestamp |
必选 |
int |
该事件对象产生的 UTC时刻。 |
dataObjectJson包含以下字段：
字段名 |
条件 |
类型 |
说明 |
|---|---|---|---|
linkid |
可选 |
String |
链路ID |
linkType |
可选 |
String |
链路类型，例如： FC、ETH |
anedn |
可选 |
String |
源网元DN |
znedn |
可选 |
String |
目的网元DN |
anePortid |
可选 |
String |
源网元端口 |
znePortid |
可选 |
String |
目的网元端口 |
aneDevType |
可选 |
String |
源网元类型 |
zneDevType |
可选 |
String |
目的网元类型 |
linkStatus |
可选 |
int |
链路状态
|
aportName |
可选 |
String |
源网元端口名称 |
zportName |
可选 |
String |
目的网元端口名称 |
通知示例
消息通知以POST方式提交，所有通知数据都保存在HTTP报文Body中。假设第三方系统WebService提供javax.servlet.http.HttpServletRequest的实现request实例（其他语言也有类似库实现），可如下获取消息数据：
调用方法 |
取得的值 |
|---|---|
request.getParameter("resourceURI") |
"/rest/openapi/notification/it/link" |
request.getParameter("msgType") |
2 |
request.getParameter("data") |
"[{\"linkid\":\"0f1c197c-e771-4805-ab2a-3183e54769c8\", \"linkType\":\"FC\", \"anedn\":\"NE=34603215\", \"znedn\":\"NE=34603209\", \"anePortid\":\"200050eb1a6a8e8e\", \"znePortid\":\"200450eb1a0c431c\", \"aneDevType\":\"FCSWITCH_DEV_TYPE\", \"zneDevType\":\"FCSWITCH_DEV_TYPE\", \"linkStatus\":0, \"aportName\":null, \"zportName\":null }]" |
request.getParameter("description") |
"IT设备之间物理链路的变更通知" |
request.getParameter("timestamp") |
"2015-06-03 16:29:31" |
返回值为“null”时，表示属性实际值为空。
