IMaster MAE-Access V100R021C10 Open API Developer Guide (Wireless Network)
IMaster MAE-Access V100R021C10 Open API Developer Guide (Wireless Network)
V100R021C10
Open API Developer Guide (Wireless
Network)
Issue 01
Date 2021-08-26
and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective
holders.
Notice
The purchased products, services and features are stipulated by the contract made between Huawei and
the customer. All or part of the products, services and features described in this document may not be
within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements,
information, and recommendations in this document are provided "AS IS" without warranties, guarantees
or representations of any kind, either express or implied.
The information in this document is subject to change without notice. Every effort has been made in the
preparation of this document to ensure accuracy of the contents, but all statements, information, and
recommendations in this document do not constitute a warranty of any kind, express or implied.
Website: https://www.huawei.com
Email: [email protected]
Contents
5 API List..........................................................................................................................................10
5.1 List of Public APIs........................................................................................................................................................10
5.1.1 Login API..................................................................................................................................................................10
5.2 List of MML APIs........................................................................................................................................................13
5.2.1 Issuing a Single MML Command.............................................................................................................................13
5.2.1.1 Format of MML NE Response Messages...............................................................................................................16
5.2.2 Issuing an MML Batch Script Task...........................................................................................................................20
5.2.2.1 Creating a Task.......................................................................................................................................................20
5.2.2.2 Querying Task Status Based on the Task ID..........................................................................................................23
5.2.2.3 Downloading the Task Execution Result Based on the Task ID............................................................................25
5.2.2.4 Deleting a Task Based on the Task ID....................................................................................................................29
5.3 List of Alarm APIs for FM...........................................................................................................................................31
5.3.1 Querying Alarms.......................................................................................................................................................31
5.4 List of Performance APIs for PM.................................................................................................................................39
5.4.1 Creating a Performance Data Query Task.................................................................................................................39
5.4.2 Obtaining Performance Data.....................................................................................................................................45
5.4.3 Deleting a Performance Result Query Task..............................................................................................................50
5.5 API for Querying Topology Cell Information..............................................................................................................52
5.6 List of iSStar APIs........................................................................................................................................................56
Issue ()
Contents
Issue ()
MAE-Access
Open API Developer Guide (Wireless Network) 1 About This Document
Purpose
An open API is a REST-based open interface provided by the MAE NBI system. REST is
short for Representational State Transfer. Third-party developers can use open APIs to access
open MAE resources, including alarm, performance, and MML modules.
Product Version
2 Open APIs
Each service releases some interfaces through northbound open APIs for third-party systems
to call.
IP address of the application Determined based on site Used for API access.
plane in the MAE system conditions
Port on the API gateway in 31127 Used for API access.
the MAE system
$ cd /export/home/sysm/ftproot/iSStarScriptStore
$ mkdir demo
$ chmod 770 demo
$ cp /home/sopuser/test.hsp3 /export/home/sysm/ftproot/iSStarScriptStore/demo/
$ cd demo
$ chmod 770 test.hsp3
Step 4 Check the files that have been uploaded to the MAE server.
Use PuTTY to log in to the MAE master service node as the sopuser user in SSH mode.
Run the following commands to obtain the sha256 verification value of the file.
$ su ossuser
$ cd /export/home/sysm/ftproot/iSStarScriptStore/demo
$ sha256sum /export/home/sysm/ftproot/iSStarScriptStore/demo/test.hsp3
----End
1.
To call iSStar APIs, you need to deploy iSStar scripts.
2.
In this document, demo and test.hsp3 are used as examples. Replace them as required.
1.
You need to switch the request body parameters to the raw mode.
1.
You need to replace userName and value with the user name and password of the user for NBI
system login authentication.
Step 4 Send the URI. If status code 200 is returned, the request is successful.
Step 5 View the response.
{
"accessSession": "x-
c97tk99iarc6kbo5hhjz09bw2n6rdeo76r08ukjw9gvxpders4ikjt5iqo0a05tgk805lfpcpebwlf
7vbvvthcuoimle6obz49lcli4bbspc2len9evsalk8sant9hhc",
"roaRand": "5ac18de46d9a7b72d3ea5ad7877ff6d566a2a24b2078f48e",
"expires": 1800,
"additionalInfo": null
}
----End
The value of X-Auth-Token is the value of accessSession obtained in "Obtaining the Token."
5 API List
Precautions
If the logged-in user has not performed any operations within 30 minutes, the session ID
automatically becomes invalid by default.
You need to create users and bind roles to the user for interconnecting with third-party
systems.
If the password is entered incorrectly for five consecutive times, the user account will be
locked. In this case, you need to manually unlock the user account on the OSS.
Call Method
PUT
URI
/api/rest/securityManagement/v1/oauth/token
Request Parameters
Sample Request
PUT
/api/rest/securityManagement/v1/oauth/token
Host: 10.10.10.10:31127
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
{
"grantType": "password",
"userName": "test",
"value": "Changeme_123"
}
Response Parameters
If the returned status code is 200, the login is successful.
session ID,
in seconds.
additionalInf No OBJECT - - Reserved
o parameter.
If the returned status code is 400, the request is invalid. For details, see the response message
body.
Sample Response
HTTP/1.1 200 OK
Date: Wed,21 Nov 2018 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"accessSession": "x-
o5gb05o8eo1fapgb49lj7wfsuqbytgvxry7w0ahds9lic59dpdqnnuga9f9gnuldg8mko7bxtigaumarlf
eltis8arhjioqlk8lecb891i5ctcbtemjxnt3x6nqr8asb",
"roaRand": "58a68cd75382dd55189d0b855463fc2370b994bfdbfead27",
"expires": 1800,
"additionalInfo": null
}
Operation Severity
Minor
Precautions
Each specified NE name must be unique.
If the number of specified NE names exceeds 100, you are advised to use a script. The
timeout period for requesting the bus is 5 minutes. If there are too many NEs, the request
may time out.
The single-command issuance API displays only messages returned in synchronous
mode. For asynchronous commands such as data synchronization, download, and version
activation commands, the single-command issuance API does not return progress and
result messages reported by NEs in asynchronous mode. If such query mode is used, you
can issue the script to the NE.
The maximum size of the request body is 2 MB.
The maximum size of a response message is 10 MB.
A maximum of 15 concurrent requests are supported.
For the MML commands that need to run for a long time or whose response messages
are large, you are advised to run them in MML batch script task issuing mode.
If multiple NE names that are specified include incorrect name, an error is reported.
Call Method
POST
URI
/api/rest/mmlManagement/v1/command
Request Parameters
Sample Request
POST /api/rest/mmlManagement/v1/command
Host: serverIP:port
Content-Type: application/json; charset=UTF-8
X-Auth-Token: x-
jupj3v47dfhf4bpjnyermo2k9jpftdmmfveqgbmppf2kjwgaikfwo5rskbjulisbbwk89ghcqovwruarft
lefvanfy5ctes9hehi2mfyoa5grzmk9fldhcft07g52rka
Content-Length:…
{
"command": "LST VER:;",
"neNames": ["pml","pTest"]
}
Response Parameters
If the returned status code is 200, the operation is successful.
The value -1
indicates
that no
subsequent
message is
received.
If the returned status code is 400, the request is invalid. For details, see the response message
body.
If the returned status code is 401, the operation is unauthorized and accessSession is invalid.
If the returned status code is 403, the requester does not have the access permission. For
details, see the response message body.
If the returned status code is 500, the server is abnormal. For details, see the response message
body.
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length:…
{
"asynchId": "0301_20210302193828_303",
"results": [{
"name": "pml",
"report": "+++ LTE 2021-03-02 19:38:47\r\nO&M #2440\r\n%
%/*1879048219*/LST VER:;%%\r\nRETCODE = 0 Operation succeeded.\r\n\r\nResult of
current software query\r\n--------------------------------\r\n Current
Software Version = BTS1 V111222\r\n Current Software Status = Normal\r\n
Current Hot Patch Version = V111222\r\n\r\n(Number of results = 1)\r\n\r\nDetail
information\r\n------------------\r\nApplication Type Application Version
Software Version Application Hot Patch Version Software Hot Patch
Version\r\n\r\neNodeB LTEV200R007C00SPC110 BTS1 V111222 V111222
BTS1 V111222\r\n(Number of results = 1)\r\n\r\n\r\n--- END\r\n\r\n",
"result": "Operation succeeded.",
"retCode": 0,
"serialId": -1
},
{
"name": "pTest",
"report": "+++ LTE 2021-03-02 19:38:47\r\nO&M #2440\r\n%
%/*1879048219*/LST VER:;%%\r\nRETCODE = 0 Operation succeeded.\r\n\r\nResult of
current software query\r\n--------------------------------\r\n Current
Software Version = BTS1 V111222\r\n Current Software Status = Normal\r\n
Current Hot Patch Version = V111222\r\n\r\n(Number of results = 1)\r\n\r\nDetail
information\r\n------------------\r\nApplication Type Application Version
Software Version Application Hot Patch Version Software Hot Patch
Version\r\n\r\neNodeB LTEV200R007C00SPC110 BTS1 V111222 V111222
BTS1 V111222\r\n(Number of results = 1)\r\n\r\n\r\n--- END\r\n\r\n",
"result": "Operation succeeded.",
"retCode": 0,
"serialId": -1
}
],
"retCode": "90000",
"retMessage": "Execution succeeded."
}
Operation Severity
Minor
Horizontal List
The horizontal list is widely used and applicable to the display of multiple returned records
that are not separated by blank lines. For example, it is used to display multiple returned
results in the following scenarios: querying all the subracks of a module, querying the status
of all the boards in a subrack, collecting entity traffic statistics, or querying the test results.
The format of a horizontal list is defined as follows:
<Attribute name 1'A0'Lw1><2SP><Attribute name 2'A0'Lw2><2SP>......<2SP><Attribute
name n'A0'Lwn>\r\n
\r\n
<Attribute 1 Value 1'A0'Lw1><2SP><Attribute 2 Value
1'A0'Lw2><2SP>......<2SP><Attribute n Value 1'A0'Lwn>\r\n
<Attribute 1 Value 2'A0'Lw1><2SP><Attribute 2 Value
2'A0'Lw2><2SP>......<2SP><Attribute n Value 2'A0'Lwn>\r\n
... ...
<Attribute 1 Value m'A0'Lw1><2SP><Attribute 2 Value
m'A0'Lw2><2SP>......<2SP><Attribute n Value m'A0'Lwn>\r\n
Note:
1. Lwn indicates the width of the attribute in column n. The maximum width of the
attribute in each column is determined based on the report requirements. The minimum
width is six characters.
2. The first line displays the attribute name of the output, which is separated from the
following data area by a blank line.
3. The attribute of each row is left-aligned.
4. The attribute name and value cannot contain two or more consecutive spaces.
5. In the horizontal list, if an attribute of a record does not have the corresponding attribute
value, NULL is used to indicate the attribute value.
Vertical List
The vertical list is applicable to the display of one or more returned records. Multiple returned
records are separated by blank lines. For example, it is used to display returned results in the
following scenarios: querying users or querying a test result.
Rule description:
1. In a vertical list, if each attribute has only one value, each row displays one attribute. The
attribute name is on the left of the equal sign, and the value is on the right of the equal
sign. The content on the left of the equal mark is right-aligned, and the content on the
right of the equal mark is left-aligned. The format is as follows:
<0SP><Attribute name 1><2SP>=<2SP><Value 1>\r\n
<0SP><Attribute name 2><2SP>=<2SP><Value 2>\r\n
<0SP><Attribute name 3><2SP>=<2SP><Value 3>\r\n
<0SP><Attribute name 4><2SP>=<2SP><Value 4>\r\n
2. In the vertical list, if an attribute does not have the corresponding attribute value, NULL
is used to indicate the attribute value. The format is as follows:
<0SP><Attribute name><2SP>=<2SP><NULL>\r\n
3. In the vertical list, if an attribute has more than one value, each value is displayed in a
line and the first value is used for left alignment. The format is as follows:
<0SP><Attribute name 1><2SP>=<2SP><Value 1>\r\n
<0SP><Attribute name 2><2SP>=<2SP><Value 2.1>\r\n
=<2SP><Value 2.2>\r\n
=<2SP><Value 2.3>\r\n
... ...
=<2SP><Value 2.x>\r\n
<0SP><Attribute name 3><2SP>=<2SP><Value 3>\r\n
<0SP><Attribute name 4><2SP>=<2SP><Value 4>\r\n
Note: < Value 2.x> indicates the xth value of the second attribute.
Note:
1. Start identifier
2. Source identifier (device name)
3. Message creation date
4. Creation time
5. Service report flag
6. Message sequence number
7. MML commands
8. Return code
9. Returned message
10. Title of the message entry
11. Attribute name
12. Attribute value
13. Message entry
14. Record in the entry
15. Result summary
16. Overall entry content
17. End flag
Function
This function allows you to create a script task based on the uploaded MML script file and the
specified task name.
Precautions
The task name must be a string of 1 to 64 characters and be unique, and cannot contain
any character in `~!@#$%^&;*()+{}[]\|':,.?<>".
The MML script file should be only in TXT format. The file content should contain the
commands and NE information.
The name of an MML script file cannot contain any character in /\<>*?|":'&.
The maximum size of the request body is 2 MB. Therefore, the size of the MML script
file cannot exceed 2 MB.
The script encryption password needs to be specified if the MML script contains the
password field. Otherwise, an error is reported.
New tasks cannot be created after the number of tasks reaches the maximum. The
maximum number of tasks depends on the number of MML scripts on the Task
Management page.
Call Method
POST
URI
/api/rest/mmlManagement/v1/tasks
Request Parameters
token.
Content-Type Request header STRING Type of the Mandatory
request message
body. The value
of this
parameter is
multipart/form
-data.
file contains
a password,
this
parameter is
used to
encrypt the
file content.
Scripts Description
The format of an MML script is as follows:
MML command:Parameters; {NE 1,NE 2,,...} /*Comment*/
1. One line in the MML script contains only one MML command.
2. MML command: parameter; is the command field, which cannot be empty. This field
cannot contain the following characters: semicolon (;), two or more consecutive percent
signs (%), two or more consecutive spaces, start characters of MML messages (+++), or
end characters of MML messages (--- END).
3. {NE 1,NE 2, and ...} indicates the target NEs and can be empty for non-CloudEdge NEs.
If {} is used, {} must be filled with NE names. You can enter multiple NE names
separated by commas (,) in single-byte character (SBC) case. The NE name cannot
contain the following characters in the SBC case: comma (,), colon (:), semicolon (;),
open brace ({), and close brace (}). For CloudEdge NEs, {NE 1,NE 2, and ...} indicates
the target VNFC and must contain one VNFC name.
4. /*comment*/ is the comment field and can be omitted. This field cannot contain the
following characters: two or more consecutive percent signs (%), two or more
consecutive spaces, start characters of MML messages (+++), or end characters of MML
messages (--- END).
The following provides an example of a correct MML script:
LST VER:; {HSS_1,HSS_2}
DSP PATCH:OT=BOARDTYPE,BT=UMPT; {HSS_1}
Sample Request
POST /api/rest/mmlManagement/v1/tasks HTTP/1.1
X-Auth-Token: x-
c9di1hbutj7u9h46hg5fjzlf2p2lio3svuti6rfvdf1dtdlidcqkipiqdi5etiukde7u47s5dcbzo9g685
2ofujx5g1fapanhdemg6ftliftilvuti48jvoapglipc2l
Host: *.*.*.*:31127
Content-Type: multipart/form-data;boundary=------FormBoundaryShouldDifferAtRuntime
------FormBoundaryShouldDifferAtRuntime
Content-Disposition: form-data; name="file"; filename="mml.txt";
taskName="mmlTask"
Content-Type: text/xml
[message-part-body; type: text/xml, size: 1924 bytes]
------FormBoundaryShouldDifferAtRuntime--
Response Parameters
If the returned status code is 200, the operation is successful.
If the returned status code is 400, the request is invalid. For details, see the response message
body.
If the returned status code is 401, the operation is unauthorized and accessSession is invalid.
If the returned status code is 403, the requester does not have the access permission. For
details, see the response message body.
If the returned status code is 500, the server is abnormal. For details, see the response message
body.
Sample Response
HTTP/1.1 200 OK
Date: Wed,21 Nov 2018 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"taskId": "123"
}
Operation Severity
Minor
Function
This function allows you to query the task status based on the returned task ID after an MML
task is created successfully.
Precautions
To query the task status, you need to use the task ID returned when the task is created.
Call Method
GET
URI
/api/rest/mmlManagement/v1/tasks/{taskId}/status
Request Parameters
Sample Request
GET /api/rest/mmlManagement/v1/tasks/123/status HTTP/1.1
X-Auth-Token: x-
jupj3v47dfhf4bpjnyermo2k9jpftdmmfveqgbmppf2kjwgaikfwo5rskbjulisbbwk89ghcqovwruarft
lefvanfy5ctes9hehi2mfyoa5grzmk9fldhcft07g52rka
Host: *.*.*.*:31127
Response Parameters
If the returned status code is 200, the operation is successful.
If the returned status code is 400, the request is invalid. For details, see the response message
body.
If the returned status code is 401, the operation is unauthorized and accessSession is invalid.
If the returned status code is 403, the requester does not have the access permission. For
details, see the response message body.
If the returned status code is 404, the requested resource does not exist or the URI is incorrect.
For details, see the response message body.
If the returned status code is 500, the server is abnormal. For details, see the response message
body.
Sample Response
HTTP/1.1 200 OK
Content-Type:application/json
{
"progress": 100,
"currentState": 3
}
Operation Severity
Minor
Function
This function allows you to download the result file of a task when the task is complete.
Precautions
The ID returned when the task is created needs to be used.
If the task does not exist or is not complete, an error is reported.
The maximum size of an MML result file is 500 MB. If the size of the result file is less
than 100 MB, the system returns a .txt file. If the size of the result file is greater than 100
MB and less than 500 MB, the system compresses the file in ZIP format and returns it.
It is recommended that a maximum of five file download requests be executed at the
same time.
Call Method
GET
URI
/api/rest/mmlManagement/v1/tasks/{taskId}/result
Request Parameters
accessSession
parameter in the
response
message body
for the API
used for
obtaining the
token.
Sample Request
GET /api/rest/mmlManagement/v1/tasks/123/result HTTP/1.1
X-Auth-Token: x-
jupj3v47dfhf4bpjnyermo2k9jpftdmmfveqgbmppf2kjwgaikfwo5rskbjulisbbwk89ghcqovwruarft
lefvanfy5ctes9hehi2mfyoa5grzmk9fldhcft07g52rka
Host: *.*.*.*:31127
Response Parameters
If the returned status code is 200, the operation is successful.
If the returned status code is 400, the request is invalid. For details, see the response message
body.
If the returned status code is 401, the operation is unauthorized and accessSession is invalid.
If the returned status code is 403, the requester does not have the access permission. For
details, see the response message body.
If the returned status code is 404, the requested resource does not exist or the URI is incorrect.
For details, see the response message body.
If the returned status code is 500, the server is abnormal. For details, see the response message
body.
Note:
1. Number of MML commands that are successfully executed
2. Number of MML commands that fail to be executed
3. Details about failed MML commands
4. Details about succeeded MML commands
5. MML command
6. NE name
7. NE response message. For details about the message format, see Format of MML NE
Response Messages.
(Number of results = 1)
Detail information
------------------
Application Type Application Version Software Version Application Hot Patch
Version Software Hot Patch Version
--- END
======================================
Operation Severity
Minor
Function
This function allows you to delete the task after the task result is downloaded to avoid the
failure to create a new task due to too many tasks.
Precautions
The ID returned when the task is created needs to be used.
A running task cannot be deleted.
After a task is executed and the task result is downloaded, this API is called to delete the
task to reduce system resource usage. If the task is not deleted immediately, MAE
automatically deletes the task that has been created for more than two days.
Call Method
DELETE
URI
/api/rest/mmlManagement/v1/tasks/{taskId}
Request Parameters
Sample Request
DELETE /api/rest/mmlManagement/v1/tasks/123 HTTP/1.1
X-Auth-Token: x-
jupj3v47dfhf4bpjnyermo2k9jpftdmmfveqgbmppf2kjwgaikfwo5rskbjulisbbwk89ghcqovwruarft
lefvanfy5ctes9hehi2mfyoa5grzmk9fldhcft07g52rka
Host: *.*.*.*:31127
Response Parameters
If the returned status code is 200, the operation is successful.
If the returned status code is 400, the request is invalid. For details, see the response message
body.
If the returned status code is 401, the operation is unauthorized and accessSession is invalid.
If the returned status code is 403, the requester does not have the access permission. For
details, see the response message body.
If the returned status code is 404, the requested resource does not exist or the URI is incorrect.
For details, see the response message body.
If the returned status code is 500, the server is abnormal. For details, see the response message
body.
Sample Response
HTTP/1.1 200 OK
Content-Type:application/json
{
}
Operation Severity
Minor
Precautions
You are advised to use exact query with filter criteria (for example, specifying AlarmId)
and avoid network-wide query without filter criteria.
In scenarios where network-wide alarm data is queried, it is recommended that the query
be performed only once a day or during off-peak hours of the MAE system.
A maximum of five iterative queries can be performed for current alarms. A maximum of
two iterative queries can be performed for historical alarms and alarm logs.
Call Method
GET
URI
/api/rest/faultSupervisonManagement/v1/alarms
OG value is case
insensitive.
CURRENT:
current
alarms
HISTORY:
historical
alarms
ALARM_L
OG: alarm
logs (current
and
historical
alarms)
alarmAckSta No String For details, Empty Alarm
te see table 3. acknowledg
ment status.
The value is
case
insensitive.
baseObjectI No String - Empty NE name or
nstance OSS. The
correspondin
g field on
the GUI is
Alarm
Source.
When the
NE name is
specified,
only one NE
can be
queried at a
time.
If the OSS is
specified,
alarms
reported by
the OSS are
queried.
filter No String For details, Empty Filter. For
see table 4. details about
the fields,
see table 4.
Use
URLEncode
to encode
the filter
before
transferring
it.
A maximum
of three filter
dimensions
are
supported.
specialAlar No Boolean true/false false Whether
m engineering
alarms are
supported.
limit No Integer 1-1000 500 Number of
alarms
displayed on
a page. The
actual
number of
reported
alarms may
be different
from the
value of
limit.
marker No String - - Iteration
factor, which
indicates
whether
there is a
subsequent
pagination
flag. If this
parameter is
not empty,
you need to
enter the
marker in
the previous
query result
during the
next iterative
query
Remarks:
1. If neither alarmAckState, baseObjectInstance, nor filter is specified, all alarms are
queried by data type by default.
field
alarmId: alarm ID Field condition for filtering.
(string) The value is case
alarmRaisedTime: UTC insensitive.
time when an alarm
The character string
occurs (long) supports the in, not in, =,
alarmClearedTime: UTC and != operators:
time when an alarm is alarmId/productName.
cleared (long)
The integer type supports
ackTime: UTC time when the <, <=, >, >=,
an alarm is between, =, !=, in, and
acknowledged (long) not in operators:
alarmRaisedTime/alarm
csn: alarm log serial ClearedTime/ackTime/cs
number (integer) n/perceivedSeverity.
productName: NE type
(string)
perceivedSeverity: alarm
severity (integer)
operator
= (equal to) Condition operator. If the
< (less than) operator is missing, an error
is returned. The value is
<= (less than or equal to) case insensitive.
> (greater than)
>= (greater than or equal
to)
!= (not equal to)
in (belongs to a set)
not in (does not belong to
a set)
Encode the JSON character string using URLEncode and send the encoded character string to
the filter.
filter=%5B%7B%22field%22%3A%22csn%22%2C%22operator%22%3A%22in%22%2C
%22values%22%3A%5B%2219142%22%2C%2219021%22%5D%7D%2C%7B%22field
%22%3A%22perceivedSeverity%22%2C%22operator%22%3A%22in%22%2C%22values
%22%3A%5B1%2C2%2C3%5D%7D%5D
Sample Request
HTTP example:
HTTP/1.1
GET
/api/rest/faultSupervisonManagement/v1/alarms?dataType=CURRENT&limit=100
Host: serverIP:port
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AUTH-TOKEN:
CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925
Response Parameters
If the returned status code is 200, the alarm query is successful.
notifyClearedAlar
m: cleared but
unacknowledged
alarm
alarmRaisedTime Yes String Alarm generation
time.
alarmClearedTime Yes String Alarm clearance
time, corresponding
to Cleared On on
the GUI.
alarmType Yes String Alarm type,
corresponding to
Type on the GUI.
1-power system, 2-
Environment system
3-Signaling system,
4-Trunk system
5-Hardware system,
6-Software system
7-Running system,
8-Communication
system
9-Qos, 10-
Processing error
11-Internal, 12-
Integrity violation
13-Operational
violation, 14-
Physical violation
15-Security service
or mechanism
violation
16-Time domain
violation
probableCause Yes String Possible cause of the
alarm.
perceivedSeverity Yes String Alarm severity,
corresponding to
Severity on the
GUI.
1-Critical, 2-Major,
3-Minor, or 4-
Warning
additionalInformatio No String Additional
n information in an
event report,
corresponding to
Additional
Information on the
GUI.
ackTime Yes String Alarm
acknowledgment
time, corresponding
to Acknowledged
On on the GUI.
ackUserId Yes String ID of the user who
acknowledges an
alarm,
corresponding to
Acknowledged By
on the GUI.
ackState Yes String Acknowledgment
status,
corresponding to
Acknowledgment
Status on the GUI.
0-Unacknowledged
or 1-Acknowledged
clearUserId No String ID of the user who
clears the alarm,
which corresponds
to Cleared By on
the GUI.
cleared No String Clearance status,
corresponding to
Clearance Status
on the GUI.
0-Uncleared or 1-
Cleared
meName No String NE name,
corresponding to
Alarm Source on
the GUI.
productName No String NE type,
corresponding to NE
Type on the GUI.
alarmName No String Alarm name,
corresponding to
Name on the GUI.
nativeMoName No String MO name,
corresponding to
MO Name on the
GUI.
csn No String Alarm serial
number,
corresponding to
Log Serial Number
on the GUI.
subCsn No String Device alarm serial
number,
corresponding to
Equipment Alarm
Serial Number on
the GUI.
specialAlarmStatus No String Maintenance status,
corresponding to
Maintenance
Status on the GUI.
comments Yes String Remarks,
corresponding to
Comment on the
GUI.
If the returned status code is 400, the request is invalid. For details, see the response message
body.
If the returned status code is 401, the operation is unauthorized and accessSession is invalid.
If the returned status code is 403, the requester does not have the access permission. For
details, see the response message body.
If the returned status code is 429, there are too many requests. For details, see the response
message body.
If the returned status code is 500, the server is abnormal. For details, see the response message
body.
Sample Response
HTTP/1.1 200 OK
Date: Mon,24 Dec 2018 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"alarmInformationList": [
{
"alarmId": "4",
"objectInstance": "Server name=OSSSVR01, SvcAgent=irppmengine-3-1,
SvcName=MAE/MAEAccessIRPPMEngine/mae_access_global, SiteName=Local Site",
"notificationType": "notifyNewAlarm",
"alarmRaisedTime": "1621859460000",
"alarmClearedTime": "0",
"alarmType": "10",
"probableCause": "",
"perceivedSeverity": "2",
"additionalInformation": "IP address=172.28.129.6, Product alias=MAE",
"ackTime": "0",
"ackUserId": "",
"ackState": "0",
"clearUserId": "",
"cleared": "0",
"meName": "OSS",
"productName": "OSS",
"alarmName": "The OSS Service Is Terminated Abnormally",
"nativeMoName": "OSS",
"csn": "21559",
"subCsn": "0",
"specialAlarmStatus": "0",
"comments": ""
}
],
"status": "OperationSucceeded",
"marker":
"MjAwJjg2MjI0OTMxNSM5ZDAzYjVkMi0yODQwLTQxZjktYjNjNC0zNjZiZjRiYjJlZjY=",
"retCode": "90000",
"retMessage": "Query succeeded."
}
Operation Severity
Minor
Precautions
Before creating a query task, ensure that the NE has issued the measurement subscription
of the corresponding counters and the query period is the same as the period for issuing
the subscription.
After the performance result query is complete, you need to immediately invoke the
function described in section 5.4.3 "Deleting a Performance Result Query Task" to delete
the performance result query task to reduce the system resource usage.
The time range of the query task must be within 24 hours. The number of counters to be
queried cannot exceed 150, and the number of function subsets to which the counters
belong cannot exceed 10.
A maximum of five concurrent requests are supported.
You are advised to specify an NE name to perform an exact query. Do not use the NE
type to perform a network-wide query. If NE types are used for a network-wide query, it
is recommended that the query be performed only once a day. In addition, do not query
data of neighboring cells on the entire network.
Call Method
POST
URI
/api/rest/performanceManagement/v1/measurementResults
Request Parameters
can be left
empty. If
isQueryAll
Ne is set to a
value other
than 0, this
parameter
must be set
to the type
of the NE to
be queried,
and only one
NE type can
be specified
at a time.
The
supported
NE types are
as follows:
BSC6900
GSM,
BSC6900
GU,
BSC6900
UMTS,
BSC6910
GSM,
BSC6910
GU,
BSC6910
UMTS,
BTS3900,
BTS5900,
micro
BTS3900,
pico
BTS3900,
eNodeB,
NodeB,
BTS3900
5G,
BTS5900
5G, micro
BTS5900,
pico
BTS3900,
and pico
BTS5900
neNames Yes Array<STRI - - List of NE
NG> names to be
queried. If
isQueryAll
Ne is set to
1, this
parameter
can be set to
an empty
array.
Otherwise,
you need to
specify the
list of NE
names to be
queried. The
NEs in a
request must
belong to
one NE type.
Sample Request
HTTP example:
POST /api/rest/performanceManagement/v1/measurementResults HTTP/1.1
Host: *.*.*.*:31127
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AUTH-TOKEN:
CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925
{
"timeFormat":"timeString",
"startTime": "2021-05-24 00:00:00",
"endTime": "2021-05-24 00:15:00",
"period": 60,
"counterIds":[
1526749447,
1526743671
],
"isQueryAllNe": 0,
"neTypeName":"eNodeB",
"neNames": [
"FmaZcc"
]
}
Response Parameters
Parameter Mandatory Type Value Default Descriptio
Range Value n
Sample Response
The task is created successfully, and the first batch of data is returned. For details about the
data structure, see 5.4.2.1.1 .
HTTP/1.1 200 OK
Mon, 24 May 2021 08:41:26 GMT
Server: example-server
Content-Type: application/json
{
"counterIds": [
1526749447,
1526743671
],
"marker": "null",
"period": 60,
"result": [
{
"counterValues": [
"77",
"71"
],
"neFdn": "NE=257",
"neName": "FmaZcc",
"objectName": "eNodeB Function Name=31_15, Local Cell ID=3, Cell
Name=CELL3, eNodeB ID=158435, Cell FDD TDD indication=CELL_TDD",
"startTime": "2021-05-24 00:00:00"
},
{
"counterValues": [
"77",
"85"
],
"neFdn": "NE=257",
"neName": "FmaZcc",
"objectName": "eNodeB Function Name=31_15, Local Cell ID=2, Cell
Name=CELL2, eNodeB ID=158435, Cell FDD TDD indication=CELL_TDD",
"startTime": "2021-05-24 00:00:00"
}
],
"retCode": "90000",
"retMessage": "Completed.",
"status": 2,
"taskId": "16",
"totalSize": 2
}
The task is created successfully, but the data is not returned immediately.
HTTP/1.1 202 OK
Content-Type:application/json
{
"retCode": "90037",
"retMessage": "The data is being collected.",
"taskId": "1569825"
}
Operation Severity
Minor
Precautions
The marker can be left empty except for the first query. Otherwise, the marker returned
by the current task in the last batch of performance result data needs to be used for each
query. If the markers are inconsistent, the performance result data cannot be obtained.
Call Method
GET
URI
/api/rest/performanceManagement/v1/measurementResults/{taskId}
Request Parameters
Sample Request
First query:
GET /api/rest/performanceManagement/v1/measurementResults/23456?limit=5000
HTTP/1.1
X-Auth-Token: x-
rxvuk4juns6nvy2lg9rz7s44g4oamkmoo5lj0bipo5fzukhc5f9cnz46ljenmr1ijthgdf5hph3v1ghgg6
pffw49hdob7w8bo54a2l899ho7c5emg6vu9jtdg6050bph
Host: *.*.*.*:31127
GET /api/rest/performanceManagement/v1/measurementResults/234571?
limit=5000&marker=8acea8ca-0dcb-11ea-8000-0050568aff80
HTTP/1.1
X-Auth-Token: x-
rxvuk4juns6nvy2lg9rz7s44g4oamkmoo5lj0bipo5fzukhc5f9cnz46ljenmr1ijthgdf5hph3v1ghgg6
pffw49hdob7w8bo54a2l899ho7c5emg6vu9jtdg6050bph
Host: *.*.*.*:31127
Response Parameters
"762",
"NIL",
"338"
],
"neFdn": "NE=24327",
"neName": "lx_test",
"objectName": "eNodeB Function Name=FM_nsjiahao, Local Cell ID=2, Cell
Name=FM_nsjiahao_2, eNodeB ID=829, Cell FDD TDD indication=CELL_FDD",
"startTime": "2021-05-19 16:00:00"
},
......
{
"counterValues": [
"330",
"220",
"969",
"595",
"339",
"248",
"299",
"892",
"588",
"83",
"341",
"NIL",
"598"
],
"neFdn": "NE=13234",
"neName": "LTE_100_005_176",
"objectName": "eNodeB Function Name=FM_nsjiahao, Local Cell ID=0, Cell
Name=FM_nsjiahao, eNodeB ID=829, Cell FDD TDD indication=CELL_FDD",
"startTime": "2021-05-19 00:00:00"
}
],
"retCode": "90000",
"retMessage": "Completed.",
"status": 2,
"taskId": "3",
"totalSize": 5000
}
Operation Severity
Minor
Precautions
If this API is not called to delete a task, MAE automatically deletes the task 12 hours
after the task is created. If you want to continue to obtain data, you need to create a query
task again.
Call Method
DELETE
URI
/api/rest/performanceManagement/v1/measurementResults/{taskId}
Request Parameters
Paramete Location Mandato Type Value Default Descripti
r ry Range Value on
Sample Request
DELETE /api/rest/performanceManagement/v1/measurementResults/0220000052 HTTP/1.1
X-Auth-Token: x-
rxvuk4juns6nvy2lg9rz7s44g4oamkmoo5lj0bipo5fzukhc5f9cnz46ljenmr1ijthgdf5hph3v1ghgg6
pffw49hdob7w8bo54a2l899ho7c5emg6vu9jtdg6050bph
Host: *.*.*.*:31127
Response Parameters
Parameter Mandatory Type Value Default Descriptio
Range Value n
Sample Response
The task is deleted successfully.
HTTP/1.1 200 OK
Content-Type:application/json
{
"retCode" : "90000",
"retMessage" : "Completed.",
"taskId" : "3"
}
Operation Severity
Minor
Precautions
In the request message, it is recommended that the number of specified FDNs be less
than or equal to 500. The timeout interval for requesting the bus is 5 minutes. If there are
too many NEs, the request may time out.
Call Method
POST
URI
/api/rest/resourceManagement/v1/topocellsinfo
Request Parameters
message body
for the API
used for
obtaining the
token.
Content-Type Request header STRING Type of the Mandatory
request message
body. The value
of this
parameter is
application/jso
n.
Sample Request
POST /api/rest/resourceManagement/v1/topocellsinfo
Host: serverIP:port
Content-Type: application/json; charset=UTF-8
X-Auth-Token: x-
jupj3v47dfhf4bpjnyermo2k9jpftdmmfveqgbmppf2kjwgaikfwo5rskbjulisbbwk89ghcqovwruarft
lefvanfy5ctes9hehi2mfyoa5grzmk9fldhcft07g52rka
Content-Length:…
{
"fdns": [
"NE=1201"
]
}
Response Parameters
If the returned status code is 200, the operation is successful.
information
and status
information.
The
following
information
is displayed
in sequence:
RAT, cell
ID, cell
name,
administrativ
e status,
activation
status,
operation
status,
availability
status, and
prompt
information.
0 ADMIN_UNLOCKED Unlocked
1 ADMIN_LOCKED Blocked
2 ACT_ACTIVE Activated
3 ACT_DEACTIVE Deactivated
4 ADMIN_UNKOWN Unknown
If the returned status code is 400, the request is invalid. For details, see the response message
body.
If the returned status code is 401, the operation is unauthorized and accessSession is invalid.
If the returned status code is 403, the requester does not have the access permission. For
details, see the response message body.
If the returned status code is 500, the server is abnormal. For details, see the response message
body.
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length:…
{
"results": [
{
"logicBTSDn": "NE=1201",
"info": "",
"neDn": "NE=1201",
"objectId": 1003224404058,
"cellInfos": [
{
"objDn": "NE=1201,eNodeBCell=0",
"cellId": 0,
"stateVals": [
0,
1,
],
"results": [
"LTE(FDD)",
"0",
"dualMod",
"Unlocked",
"Inactive",
"Enable",
"Invalid",
""
]
},
{
"objDn": "NE=1201,eNodeBCell=1",
"cellId": 1,
"stateVals": [
0,
2,
],
"results": [
"LTE(FDD)",
"1",
"dualMod_1",
"Unlocked",
"Inactive",
"Enable",
"Invalid",
""
]
}
]
}
]
}
Operation Severity
Minor
Precautions
Currently, the maximum number of concurrent iSStar tasks is 75, and the maximum
number of tasks is 200.
The tasks will be deleted 48 hours after the execution is complete.
Call Method
POST
URI
/api/rest/scriptsManagement/v1/tasks
Request Parameters
which is a
standard
JSON
character
string.
Sample Request
HTTP example:
POST /api/rest/scriptsManagement/v1/tasks HTTP/1.1
Host: *.*.*.*:31127
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AUTH-TOKEN:
CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925
{
"entryScript": "test.hsp3",
"scriptPath": "demo",
"startTime": "string",
"scriptHashValue":
"*************************************************************",
"scriptParams": [
{
"data": "test"
}
]
}
Response Parameters
status is
abnormal
jobExecResult STRING - - Processing:
The task is
running.
Failed: The
task fails to be
executed.
Successful: The
task is executed
successfully.
NotExist: The
task does not
exist.
Unknown: The
running result is
abnormal.
userName STRING - - Name of the
user who
creates tasks.
Sample Response
HTTP/1.1 200 OK
Date: Tue, 7 Jan 2020 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"data": [
{
"jobStatus": "Running",
"retMessage": "Process task successfully.",
"id": "15103",
"href":
"/mnf/10.185.172.143/api/rest/scriptsManagement/v1/tasks/15103",
"retCode": "0",
"username": "northAPIUser"
}
]
}
Operation Severity
Minor
Precautions
If the size of the returned result is less than 10 MB, the result is returned directly. If the
size is greater than 10 MB, you need to download the iSStar task result report by
following the instructions provided in Downloading the iSStar Task Result Report.
Call Method
GET
URI
/api/rest/scriptsManagement/v1/tasks/{jobId}
Request Parameters
None
Sample Request
HTTP example:
GET /api/rest/scriptsManagement/v1/tasks/{jobId} HTTP/1.1
Host: *.*.*.*:31127
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AUTH-TOKEN:
CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925
Response Parameters
query.
extInfo STRING Result
information
generated
during script
execution. If the
size is less than
10 MB, the
result
information is
displayed
directly. If the
size is greater
than 10 MB, no
result
information is
displayed.
extCode STRING Result of
obtaining the
script execution
result.
0: The
information is
obtained
successfully.
1: The file does
not exist.
2: The file size
exceeds 10 MB.
3: The
information
fails to be
obtained.
Sample Response
HTTP/1.1 200 OK
Date: Tue, 7 Jan 2020 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"data": [
{
"jobStatus": "Finished",
"extCode": "1",
"retMessage": "Process task successfully.",
"endTimeGmt": "2021-05-20T09:48:56GMT+08:00",
"reportUri":
"/mnf/10.185.172.143/api/rest/scriptsManagement/v1/files/15108/result.zip",
"progress": "100%",
"id": "15108",
"href":
"/mnf/10.185.172.143/api/rest/scriptsManagement/v1/tasks/15108",
"retCode": "0",
"jobExecResult": "Failed",
"username": "northAPIUser",
"extInfo": ""
}
]
}
Operation Severity
Minor
Precautions
After a task is executed and the task result is downloaded, this API is called to delete the
task to reduce system resource usage. If the task is not deleted immediately, MAE
automatically deletes the task that has been completed for more than two days.
Call Method
DELETE
URI
/api/rest/scriptsManagement/v1/tasks/{jobId}
Request Parameters
None
Sample Request
HTTP example:
DELETE /api/rest/scriptsManagement/v1/tasks/{jobId} HTTP/1.1
Host: *.*.*.*:31127
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AUTH-TOKEN:
CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925
Delete Data
Task execution result and task ID in the task list.
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Tue, 7 Jan 2020 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"data": [
{
"retMessage": "Process task successfully.",
"id": "15108",
"href":
"/mnf/10.185.172.143/api/rest/scriptsManagement/v1/tasks/15108",
"retCode": "0",
"username": "northAPIUser"
}
]
}
Operation Severity
Minor
Precautions
You can download the result report of a task only after the query task is complete.
Call Method
GET
URI
/mnf/{IP}/api/rest/scriptsManagement/v1/files/{jobId}/result.zip
Request Parameters
None
Sample Request
HTTP example:
GET /mnf/{IP}/api/rest/scriptsManagement/v1/files/{jobId}/result.zip HTTP/1.1
Host: *.*.*.*:31127
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AUTH-TOKEN:
CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925
Response Parameters
If the returned status code is 200, the download is successful.
If the returned status code is 400, the request is invalid. For details, see the response message
body.
If the returned status code is 401, the operation is unauthorized and accessSession is invalid.
For details, see the response message body.
If the returned status code is 403, the requester does not have the access permission. For
details, see the response message body.
If the returned status code is 404, the requested resource does not exist or the URI is incorrect.
For details, see the response message body.
If the returned status code is 500, the request fails to be processed. For details, see the
response message body.
Operation Severity
Minor
Precautions
You have called the API in 5.1 Login API to obtain the token information.
Call Method
POST
URI
/api/rest/oss-info/v1/connection-status
Request Parameters
Sample Request
POST /api/rest/oss-info/v1/connection-status HTTP/1.1
Host: serverIP:port
accessToken: 52661fbd-6b84-4fc2-aa1e-17879a5c6c9b
Content-Type: application/json; charset=UTF-8
Content-Length:…
{
}
Response Parameters
If the returned status code is 200, the API is successfully called.
If the returned status code is 400, the request is invalid. For details, see the response message
body.
If the returned status code is 401, the operation is unauthorized and accessSession is invalid.
If the returned status code is 403, the requester does not have the access permission. For
details, see the response message body.
If the returned status code is 429, there are too many requests. For details, see the response
message body.
If the returned status code is 500, the service is abnormal. For details, see the response
message body.
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length:…
{
"retCode": 0
}
Operation Severity
Minor
Precautions
You have called the API in 5.1 Login API to obtain the token information.
Call Method
GET
URI
/api/rest/oss-info/v1/omcid
Request Parameters
Sample Request
POST /api/rest/oss-info/v1/omcid HTTP/1.1
Host: serverIP:port
accessToken: 52661fbd-6b84-4fc2-aa1e-17879a5c6c9b
Content-Type: application/json; charset=UTF-8
Content-Length:…
{
}
Response Parameters
If the returned status code is 200, the API is successfully called.
If the returned status code is 400, the request is invalid. For details, see the response message
body.
If the returned status code is 401, the operation is unauthorized and accessSession is invalid.
If the returned status code is 403, the requester does not have the access permission. For
details, see the response message body.
If the returned status code is 429, there are too many requests. For details, see the response
message body.
If the returned status code is 500, the service is abnormal. For details, see the response
message body.
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length:…
{
"omcId": "X"
}
Operation Severity
Minor
Precautions
You have called the API in 5.1 Login API to obtain the token information.
Call Method
GET
URI
/api/rest/oss-info/v1/mae-version
Request Parameters
Sample Request
POST /api/rest/oss-info/v1/mae-version HTTP/1.1
Host: serverIP:port
accessToken: 52661fbd-6b84-4fc2-aa1e-17879a5c6c9b
Content-Type: application/json; charset=UTF-8
Content-Length:…
{
}
Response Parameters
If the returned status code is 200, the API is successfully called.
If the returned status code is 400, the request is invalid. For details, see the response message
body.
If the returned status code is 401, the operation is unauthorized and accessSession is invalid.
If the returned status code is 403, the requester does not have the access permission. For
details, see the response message body.
If the returned status code is 429, there are too many requests. For details, see the response
message body.
If the returned status code is 500, the service is abnormal. For details, see the response
message body.
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length:…
{
"version": "V100R021C10"
}
Operation Severity
Minor