No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

eSight V300R010C00SPC200, 300, and 500 Self-Service Integration Guide 10

Rate and give feedback:
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
Network Link Change Notification

Network Link Change Notification

Subscribing to the Network Link Change Notification

Function

This interface is used to subscribe to the network link change notification.

URI

/rest/openapi/notification/network/link

Access Method

PUT

Parameter Description

Parameter

Mandatory/Optional

Location

Value Type

Description

openid

Mandatory

Request header parameter list

String

Indicates a session ID, used for open API authorization.

NOTE:

A third-party system invokes the login interface of the security management module to obtain the value of this parameter.

systemID

Mandatory

Request entity parameter list

String

Indicates the third-party system ID.

NOTE:

The value can be an IP address of 1 to 64 characters, including digits (0-9), lowercase letters (a-z), uppercase letters (A-Z), and the following special characters: @ _ - ( ) , . ^ $ ~ ` !

openID

Mandatory

Request entity parameter list

String

Indicates the credential used by eSight to proactively connect to a third-party system. Third-party systems assign credentials and use credentials for authentication.

NOTE:

The value consists of 1 to 1024 characters, including digits (0-9), lowercase letters (a-z), uppercase letters (A-Z), and the following special characters: @ _ - ( ) , . ^ $ ~ ` !

url

Mandatory

Request entity parameter list

String

Indicates the URL to which eSight sends notification messages in POST mode.

NOTE:

For example, http://10.10.10.10:8080/device. The URL correctness must be ensured by the notification message subscriber. The IP address is specified in the Open API whitelist. The value consists of 1 to 1024 characters complying with the HTTP URL encoding specification.

dataType

Optional

Request entity parameter list

String

Indicates the value type of the data field in the notification message.

NOTE:

Currently, only the JSON value type is supported. The default value is JSON.

desc

Optional

Request entity parameter list

String

Indicates the third-party system description.

NOTE:

The default value is null, indicating that no description is provided. The value is a string of 0 to 1024 characters without any restriction.

Result

Field

Value Type

Description

code

int

Indicates the return code. The options are as follows:

  • 0: succeeded
  • Non-0: failed

data

List

The field is displayed as null.

description

String

Indicates the description of the interface invoking result.

Precautions

None.

Unsubscribing from the Network Link Change Notification

Function

This interface is used to unsubscribe from the network link change notification.

URI

/rest/openapi/notification/network/link

Access Method

DELETE

Parameter Description

Parameter

Mandatory/Optional

Location

Value Type

Description

openid

Mandatory

Request header parameter list

String

Indicates a session ID, used for open API authorization.

NOTE:

A third-party system invokes the login interface of the security management module to obtain the value of this parameter.

systemID

Mandatory

Parameter list

string

Indicates the third-party system ID (the value can be an IP address).

desc

Optional

Parameter list

string

Indicates the third-party system description.

Result

Field

Value Type

Description

code

int

Indicates the return code. The options are as follows:

  • 0: succeeded
  • Non-0: failed

data

List

The field is displayed as null.

description

string

Indicates the description of the interface invoking result.

Precautions

None.

Data Structure of Network Link Change Notifications

Message Data

Field

Value Type

Description

resourceURI

String

Indicates the resource URI, which is the same as the URI of the subscribed message. It is fixed as /rest/openapi/notification/network/link.

msgType

int

Indicates the message type. The options are as follows:

  • 1: create
  • 2: delete
  • 3: modify

data

List<LinkModelForWebNotify>

Indicates the service data. One notification message carries change information of only one link instance.

description

String

Indicates the description.

timestamp

String

Indicates the event occurrence time, which is the Coordinated Universal Time (UTC) of the time zone of the eSight server.

The value must be in the yyyy-mm-dd hh:MM:ss format.

The following table lists the fields contained in the LinkModelForWebNotify object.

Field

Value Type

Description

linkdn

String

Indicates the link DN.

linkname

String

Indicates the link name.

anedn

String

Indicates the source NE DN.

anename

String

Indicates the source NE name.

anestate

int

Indicates the source NE status. The options are as follows:

  • 0: not detected
  • 1: online
  • 2: offline
  • 3: unknown
  • 4: error

aportdn

String

Indicates the source port DN.

aportname

String

Indicates the source port name.

aportip

String

Indicates the IP address of the source port.

aportadminstatus

int

Indicates the administrative status of the source port. The options are as follows:

  • 1: up
  • 2: down
  • 3: testing

aportoperstatus

int

Indicates the running status of the source port. The options are as follows:

  • 1: up
  • 2: down
  • 3: testing
  • 4: unknown
  • 5: dormant
  • 6: notPresent
  • 7: lowLayerDown

znedn

String

Indicates the destination NE DN.

znename

String

Indicates the destination NE name.

znestate

int

Indicates the destination NE status. The options are as follows:

  • 0: not detected
  • 1: online
  • 2: offline
  • 3: unknown
  • 4: error

zportdn

String

Indicates the destination port DN.

zportname

String

Indicates the destination port name.

zportip

String

Indicates the IP address of the destination port.

zportadminstatus

int

Indicates the administrative status of the destination port. The options are as follows:

  • 1: up
  • 2: down
  • 3: testing

zportoperstatus

int

Indicates the running status of the destination port. The options are as follows:

  • 1: up
  • 2: down
  • 3: testing
  • 4: unknown
  • 5: dormant
  • 6: notPresent
  • 7: lowLayerDown

linkstatus

int

Indicates the link status. The options are as follows:

  • 0: normal
  • 1: unknown
  • 2: major fault
  • 3: critical fault
  • 4: offline
  • 5: not detected

linktype

int

Indicates the link type. The options are as follows:

  • 1: LLDP
  • 2: Side-By-Side
  • 3: MAC
  • 4: CDP
  • 5: IP link with non-30-bit mask
  • 6: Eth-Trunk links generated by physical links
  • 99: Manual

speed

String

Indicates the bandwidth, in Mbit/s.

Example

The message is sent in POST mode, and all notification data is saved in the body of the HTTP packet. Assume that the third-party system WebService provides the implementation request instance of javax.servlet.http.HttpServletRequest, the following message data can be obtained.

Invoking Method

Obtained Value

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\":\"205.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\":\"205.0.0.2\",

\"zportadminstatus\":1,

\"zportoperstatus\":2,

\"linkstatus\":4,

\"linktype\":2,

\"speed\":\"1000\"

}]"

request.getParameter("description")

"Change notification of physical links between network devices"

request.getParameter("timestamp")

"2015-06-03 16:29:31"

The value null indicates that the actual value of an attribute is empty.

Translation
Download
Updated: 2019-10-30

Document ID: EDOC1100044386

Views: 15220

Downloads: 83

Average rating:
This Document Applies to these Products
Related Documents
Related Version
Share
Previous Next