网络链路变更消息
介绍订阅和取消订阅网络链路变更通知。
订阅网络链路变更通知
接口功能
订阅网络链路变更通知接口。
URI路径
/rest/openapi/notification/network/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 |
接口调用结果的描述信息。 |
注意事项
无。
取消订阅网络链路变更通知
接口功能
取消订阅网络链路变更通知的接口。
URI路径
/rest/openapi/notification/network/link
访问方法
DELETE
参数说明
参数名 |
必选/可选 |
参数位置 |
参数类型 |
参数说明 |
---|---|---|---|---|
openid |
必选 |
请求头参数列表 |
String |
会话标识,用于Open API的鉴权。 说明:
该参数由第三方调用安全管理登录接口获取openid。 |
systemID |
必选 |
参数列表 |
String |
第三方系统标识(可为IP地址) |
desc |
可选 |
参数列表 |
String |
第三方系统描述 |
返回结果
字段名 |
类型 |
说明 |
---|---|---|
code |
int |
操作返回码。可以是如下值之一:
|
data |
List |
此处为null |
description |
String |
接口调用结果的描述信息。 |
注意事项
无。
网络链路变更通知的数据结构
消息数据
字段名 |
类型 |
说明 |
---|---|---|
resourceURI |
String |
资源类型 URI,与订阅消息的URI定义一致,该变更通知固定为“/rest/openapi/notification/network/link”字符串。 |
msgType |
int |
消息类型。取值范围:
|
data |
List<LinkModelForWebNotify> |
业务数据,一个通知消息仅携带一个资源实例的变更 |
description |
String |
描述信息 |
timestamp |
String |
事件发生的时间,eSight服务器所在时区的协调时间: 格式:yyyy-mm-dd hh:MM:ss |
LinkModelForWebNotify包含以下字段:
字段名 |
类型 |
说明 |
---|---|---|
linkdn |
String |
链路DN |
linkname |
String |
链路名称 |
anedn |
String |
源网元DN |
anename |
String |
源网元名称 |
anestate |
int |
源网元状态,可能为以下值:
|
aportdn |
String |
源端口DN |
aportname |
String |
源端口名称 |
aportip |
String |
源端口IP |
aportadminstatus |
int |
源端口管理状态,可能为以下值:
|
aportoperstatus |
int |
源端口运行状态,可能为以下值:
|
znedn |
String |
宿网元DN |
znename |
String |
宿网元名称 |
znestate |
int |
宿网元状态,可能为以下值:
|
zportdn |
String |
宿端口DN |
zportname |
String |
宿端口名称 |
zportip |
String |
宿端口IP |
zportadminstatus |
int |
宿端口管理状态,可能为以下值:
|
zportoperstatus |
int |
宿端口运行状态,可能为以下值:
|
linkstatus |
int |
链路状态,可能为以下值:
|
linktype |
int |
链路类型,可能为以下值:
|
speed |
String |
带宽,单位为Mbit/s |
通知示例
消息通知以POST方式提交,所有通知数据都保存在HTTP报文Body中。假设第三方系统WebService提供javax.servlet.http.HttpServletRequest的实现request实例(其他语言也有类似库实现),可如下获取消息数据:
调用方法 |
取得的值 |
---|---|
request.getParameter("resourceURI") |
"/rest/openapi/notification/network/link" |
request.getParameter("msgType") |
3 |
request.getParameter("data") |
"[{ \"linkdn\":\"3_-1298870359279059506112101902889\", \"linkname\":\"S5700-52C-SI2222_Vlanif205_auto_resource_205_Vlanif205!\", \"anedn\":\"NE=34603125\", \"anename\":\"S5700-52C-SI2222\", \"aneip\":\"10.137.61.202\", \"anestate\":2, \"aportdn\":\"NE=34603125_310\", \"aportname\":\"Vlanif205\", \"aportip\":\"10.0.0.1\", \"aportadminstatus\":1, \"aportoperstatus\":1, \"znedn\":\"NE=34603119\", \"znename\":\"auto_resource_205!\", \"zneip\":\"10.137.61.205\", \"znestate\":2, \"zportdn\":\"NE=34603119_39\", \"zportname\":\"Vlanif205\", \"zportip\":\"10.0.0.2\", \"zportadminstatus\":1, \"zportoperstatus\":2, \"linkstatus\":4, \"linktype\":2, \"speed\":\"1000\" }]" |
request.getParameter("description") |
"网络设备之间物理链路的变更通知" |
request.getParameter("timestamp") |
"2015-06-03 16:29:31" |
返回值为“null”时,表示属性实际值为空。