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).
IT Device Link Change Notifications

IT Device Link Change Notifications

Subscribing to IT Device Link Change Notifications

Function

Subscribe to the IT device link change notification interface.

URI

/rest/openapi/notification/it/link

Access Method

PUT

Parameter Description

Parameter

Mandatory/Optional

Location

Value Type

Parameter Description

openid

Mandatory

Request header parameter list

String

Indicates session ID, used for open API authorization.

NOTE:

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

systemID

Mandatory

Requestentity parameter list

String

ID o fa third-party system.

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

Requestentity parameter list

String

Credential that eSight uses to connect to a third-party system. The third-party system assigns and uses this credential 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

Requestentity parameter list

String

URL to which eSight sends notifications in POST mode.

NOTE:

An example value is http://10.10.10.10:8080/device. The subscriber must ensure that the URL is correct and that the IP address is in the OpenAPI whitelist. The URL must consist of 1–1024 characters andcomply with the HTTP URL coding specifications.

dataType

Optional

Requestentity parameter list

String

Data field type of notification packets.

NOTE:

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

desc

Optional

Requestentity parameter list

String

Description of a third-party system.

NOTE:

This parameter is blank by default. The value consists of 0 to 1024 characters. The character set is not restricted.

Result

Field

Value Type

Description

code

int

Operation return code. The options are as follows:

  • 0: success
  • Others: failure

data

List

This parameter is blank.

description

String

Descriptive information about interface invocation results.

Precautions

None.

Unsubscribing from IT Device Link Change Notifications

Function

Unsubscribe from IT device link change notifications.

URI

/rest/openapi/notification/it/link

Access Method

DELETE

Parameter Description

Parameter

Mandatory/Optional

Location

Value Type

Parameter Description

systemID

Mandatory

Parameterlist

String

ID o fa third-party system. The value can be an IP address.

desc

Optional

Parameterlist

String

Description of a third-party system.

Result

Field

Value Type

Parameter Description

code

int

Operation return code. The options are as follows:

  • 0: success
  • Others: failure

data

List

This parameter is blank.

description

String

Descriptive information about interface invocation results.

Precautions

None.

Data Structure of IT Device Link Change Notifications

Message Data

Field

Mandatory/Optional

Value Type

Parameter Description

msgType

Mandatory

int

Mandatory.

The options are as follows:

  • 1: create
  • 2: delete

resourceURI

Mandatory

String

/rest/openapi/notification/it/link

moduleID

Mandatory

String

ModuleID.

Example: com.huawei.it.link.notification

dataObjectJson

Mandatory

String

Data content. The value is a JSON string of link information.

utcTimestamp

Mandatory

int

UTCtime when the event occurs.

Fields in dataObjectJson:

Field

Mandatory/Optional

Value Type

Parameter Description

linkid

Optional

String

Link ID.

linkType

Optional

String

Linktype, for example, FC or ETH.

anedn

Optional

String

DN of the source NE.

znedn

Optional

String

DN of the target NE.

anePortid

Optional

String

Port number of the source NE.

znePortid

Optional

String

Port number of the target NE.

aneDevType

Optional

String

Type of the source NE.

zneDevType

Optional

String

Type of the target NE.

linkStatus

Optional

int

Link status.

  • 0:Normal
  • 1:Unknown
  • 2:Major
  • 3:Critical
  • 4:Offline
  • 5:Unmanaged

aportName

Optional

String

Port name of the source NE.

zportName

Optional

String

Port name of the target NE.

Example

Message notifications are submitted in POST mode. All notification data is stored in the bodies of HTTP packets. Assume that a third-party system WebService provides the javax.servlet.http.HttpServletRequest class for request instance implementation. The invoking methods and corresponding values are listed in the following table.

Invoking Method

Value Obtained

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}]"

request.getParameter("description")

"Notifications on the changes of the physical links between IT devices"

request.getParameter("timestamp")

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

If the return value is null, the actual value of the property is blank.

Translation
Download
Updated: 2019-10-30

Document ID: EDOC1100044386

Views: 17758

Downloads: 87

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