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 11

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).
AP Resource Change Notification

AP Resource Change Notification

This section describes how to subscribe to and unsubscribe from network AP resource change notifications.

Subscribing to the AP Resource Change Notification

Function

This interface is used to subscribe to the AP resource change notification.

URI

/rest/openapi/notification/network/wlan/ap

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:

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. 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 AP Resource Change Notification

Function

This interface is used to unsubscribe from the AP resource change notification.

URI

/rest/openapi/notification/network/wlan/ap

Access Method

DELETE

Parameter Description

Parameter

Mandatory/Optional

Location

Value Type

Description

openid

Mandatory

Request message header

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 the AP Resource Change Notification

Message Data

Field

Value Type

Description

resourceURI

String

Indicates the AP resource URI, which is consistent with the URI of the subscribed notification message. The AP resource change notification message is a fixed character string /rest/openapi/notification/network/wlan/ap.

msgType

int

Indicates the message type. The options are as follows:

  • 1: created message
  • 2: deleted message
  • 3: modified message

data

List<NeDe

tailInfoExt>

Indicates the service data. A notification message contains change information of only one resource instance.

description

String

Indicates the message description.

timestamp

String

Indicates the event occurrence time, that is the Universal Time Coordinated (UTC) of the time area where the eSight server is located.

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

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

Field

Value Type

Description

nodeDn

String

Indicates the unique identifier of the AP.

neDn

String

Indicates the unique identifier of the connected AC.

apId

String

Indicates the AP index.

apName

String

Indicates the AP name.

status

int

Indicates the status.

5, 7, 8, and 9: online

12: version mismatch

2: to be determined

1 and 4: offline

Others: faulty

apType

String

Indicates the AP type.

mac

String

Indicates the MAC address of an AP.

apIp

String

Indicates the IP address of an AP.

acName

String

Indicates the name of the connected AC.

locationId

String

Indicates the region ID.

regionLocation

String

Indicates the region where an AP is located.

apAlias

String

Indicates the AP alias.

category

String

Indicates the category.

1: Fit AP

2: Fat AP

apVersion

String

Indicates the AP software version.

sn

String

Indicates the AP SN.

apRegionName

String

Indicates the AP domain.

antennaMode

int

Indicates the antenna mode.

0: unknown

1: auto mode

2: left mode

3: right mode

groupName

String

Indicates the AP group name.

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. (If other languages are used, the implementation request instance is similar.)

Invoking Method

Obtained Value

request.getParameter("resourceURI")

"/rest/openapi/notification/network/wlan/ap"

request.getParameter("msgType")

3

request.getParameter("data")

"[{

\"nodeDn\": \"NE=34603110\",

\"neDn": \"NE=34603109\",

\"apId\": \"0\",

\"apName\": \"AP21333\",

\"status\": 4,

\"apType\": \"AP6010DN-AGN\",

\"mac\": \"10-1B-55-41-E7-5A\",

\"apIp\": \"10.137.25.36\",

\"acName\": \"Router\",

\"locationId\": \"null\",

\"regionLocation\": \"CHINA\",

\"apAlias\": \"\",

\"category\": \"1\",

\"apVersion\": \"\",

\"sn\": \"\",

\"apRegionName\": \"ap-region-0\",

\"antennaMode\":1,

\"groupName\":\"default\"

}]"

request.getParameter("description")

"Resources of AP change notification"

request.getParameter("timestamp")

"2015-09-08 16:29:31"

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

Download
Updated: 2019-12-13

Document ID: EDOC1100044386

Views: 18044

Downloads: 87

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