Huawei iMaster NetEco Northbound Interface Reference

https://support.huawei.com/enterprise/en/doc/
Admin
This documentation provides a comprehensive guide to the northbound interfaces, architecture,...
Tokens:14,249
Snippets:168
Trust Score:9.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### Plant List Request Example

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/4217ab29/plant-list-interface

This is an example of a request payload to retrieve a list of plants. It includes pagination parameters.

```JSON
{
  "pageNo": 1,
  "gridConnectedStartTime":1664718569000,
  "gridConnectedEndTime":1667396969000
}
```

--------------------------------

### Plant List Response Example - Success

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/4217ab29/plant-list-interface

This example demonstrates a successful response when retrieving the plant list. It includes pagination details and a list of plant objects.

```JSON
{
  "success": true,
  "data": {
    "list": [
      {
        "plantCode": "NE=12345678",
        "plantName": "NMplant1",
        "plantAddress": null,
        "longitude": null,
        "latitude": null,
        "capacity": 146.5,
        "contactPerson": "",
        "contactMethod": "",
        "gridConnectionDate": "2022-11-21T16:23:00+08:00"
      },
      {
        "plantCode": "NE=23456789",
        "plantName": "plant2",
        "plantAddress": null,
        "longitude": null,
        "latitude": null,
        "capacity": 123.3,
        "contactPerson": "",
        "contactMethod": "",
        "gridConnectionDate": "2022-11-21T16:30:28-12:00"
      }
    ],
    "pageCount": 1,
    "pageNo": 1,
    "pageSize": 100,
    "total": 2
  },
  "failCode": 0,
  "message": "get plant list success"
  }
```

--------------------------------

### Successful Login Response Example

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/9e1a18d2/login-interface

This example demonstrates a successful response from the iMaster NetEco login interface. It indicates success and returns a failCode of 0.

```json
{
    "success":true,
    "data":null,
    "failCode":0,
    "params":null,
    "message":null
}
```

--------------------------------

### Failed Login Response Example

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/9e1a18d2/login-interface

This example shows a failed login response from the iMaster NetEco system, indicated by 'success: false' and a specific 'failCode' (e.g., 20001).

```json
{
    "data":null,
    "failCode":20001,
    "message":"",
    "params":{
        "currentTime":1593777870514
    },
    "success":false
}
```

--------------------------------

### Logout Interface Request Example

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/2cbb1384/logout-interface

This is an example of the JSON payload to send when invoking the logout interface. It requires the xsrfToken obtained from a successful login.

```json
{
    "xsrfToken":"x-apepjy1fpd2ptete1f7zuqimep7wuqen9hkb3xaourelbyrx9jio7s09hgk6ca2mdlksjdglasdhjaklsdfhhdsahwedyuioqwehjkd"
}
```

--------------------------------

### XSRF-TOKEN in Request Header Example

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/9e1a18d2/login-interface

This example illustrates how to include the XSRF-TOKEN in the request header for subsequent data interface requests after a successful login.

```http
POST /thirdData/getPlantList HTTP/1.1
Host: Domain name of the management system
Content-Type: application/json
Accept: application/json
X-XSRF-TOKEN: 74a21a1a-117e-4996-8760-314422923091
```

--------------------------------

### Plant List Response Example - Error

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/4217ab29/plant-list-interface

This example shows the response when an error occurs, such as an invalid time parameter. It indicates failure and provides an error code and message.

```JSON
{
  "success": false,
  "data": null,
  "failCode": 20605,
  "message": "The time cannot be a negative number."
}
```

--------------------------------

### Device Alarm Interface Response Example - Success

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/9977dccb/device-alarm-interface

This response example shows a successful retrieval of alarm data for devices. It includes details about each alarm, such as cause, ID, name, and time.

```json
{
    "data": [
        {
            "alarmCause": "An unrecoverable fault has occurred in the internal circuit of the device.",
            "alarmId": 2064,
            "alarmName": "The device is abnormal.",
            "alarmType": 2,
            "causeId": 5,
            "devName": "Inverter-1",
            "devTypeId": 38,
            "esnCode": "Inverter05",
            "lev": 2,
            "raiseTime": 1667179861000,
            "repairSuggestion": "Turn off the AC and DC switches, wait for 5 minutes, and then turn on the AC and DC switches. If the fault persists, contact your dealer or technical support.",
            "stationCode": "NE=33554792",
            "stationName": "hzhStation02",
            "status": 1
        },
        {
            "alarmCause": "1. The voltage of a battery expansion module is low.",
            "alarmId": 3011,
            "alarmName": "Battery expansion module undervoltage",
            "alarmType": 2,
            "causeId": 2,
            "devName": "Inverter-2",
            "devTypeId": 38,
            "esnCode": "Inverter01",
            "lev": 4,
            "raiseTime": 1665264943000,
            "repairSuggestion": "1. If the sunlight is sufficient or AC reverse charging is allowed, the Battery [CNo] battery expansion module [SNo] (in the fault location information) can be charged when the inverter is running.",
            "stationCode": "NE=33554785",
            "stationName": "hzhStation01",
            "status": 1
        }
    ],
    "failCode": 0,
    "message": null,
    "params": {
        "currentTime": 1667399432812,
        "sns": "Inverter01",
        "language": "zh_CN",
        "beginTime": 1664553600000,
        "devTypes": "1,2,38,46,62",
        "endTime": 1667231999000,
        "levels": "1,2,3,4",
        "stationCodes": "NE=33554785,NE=33554792"
    },
    "success": true
}
```

--------------------------------

### Get Device Alarms

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/9977dccb/device-alarm-interface

Retrieves alarm data for devices based on specified criteria. Supports filtering by station codes, device serial numbers, time ranges, language, alarm levels, and device types. Includes examples for both successful responses with alarm data and error responses.

```APIDOC
## POST /device/alarm

### Description
Retrieves alarm data for devices. This endpoint allows filtering alarms by station codes, device serial numbers, time ranges, language, alarm levels, and device types. It provides examples for successful alarm data retrieval and error scenarios.

### Method
POST

### Endpoint
/device/alarm

### Parameters
#### Request Body
- **stationCodes** (string) - Optional - Comma-separated list of station codes (e.g., "NE=33554785,NE=33554792").
- **sns** (string) - Optional - Comma-separated list of device serial numbers (e.g., "Inverter01").
- **beginTime** (string) - Optional - Start timestamp for the alarm period in milliseconds (e.g., "1664553600000").
- **endTime** (string) - Optional - End timestamp for the alarm period in milliseconds (e.g., "1667231999000").
- **language** (string) - Optional - Language for the response (e.g., "zh_CN").
- **levels** (string) - Optional - Comma-separated list of alarm levels (e.g., "1,2,3,4").
- **devTypes** (string) - Optional - Comma-separated list of device types (e.g., "1,2,38,46,62").

### Request Example
```json
{
    "stationCodes":"NE=33554785,NE=33554792",
    "sns":"Inverter01",
    "beginTime":"1664553600000",
    "endTime":"1667231999000",
    "language":"zh_CN",
    "levels":"1,2,3,4",
    "devTypes":"1,2,38,46,62"
}
```

### Response
#### Success Response (200)
- **data** (array) - List of alarm objects if successful. Each alarm object may contain:
  - **alarmCause** (string) - Description of the alarm cause.
  - **alarmId** (integer) - Unique identifier for the alarm.
  - **alarmName** (string) - Name of the alarm.
  - **alarmType** (integer) - Type of the alarm.
  - **causeId** (integer) - Identifier for the cause of the alarm.
  - **devName** (string) - Name of the device.
  - **devTypeId** (integer) - Type identifier of the device.
  - **esnCode** (string) - Serial number of the device.
  - **lev** (integer) - Alarm level.
  - **raiseTime** (integer) - Timestamp when the alarm was raised.
  - **repairSuggestion** (string) - Suggested steps for repairing the alarm.
  - **stationCode** (string) - Code of the station where the device is located.
  - **stationName** (string) - Name of the station.
  - **status** (integer) - Current status of the alarm.
- **failCode** (integer) - Error code. 0 indicates success.
- **message** (string) - Additional message, null if successful.
- **params** (object) - Parameters used in the request.
- **success** (boolean) - True if the request was successful, false otherwise.

#### Error Response (e.g., failCode 20055)
- **data** (null) - Data field is null in case of an error.
- **failCode** (integer) - Error code indicating the type of failure.
- **message** (string) - Error message, can be null.
- **params** (object) - Parameters used in the request.
- **success** (boolean) - False, indicating the request failed.

### Response Example (Success)
```json
{
    "data": [
        {
            "alarmCause": "An unrecoverable fault has occurred in the internal circuit of the device.",
            "alarmId": 2064,
            "alarmName": "The device is abnormal.",
            "alarmType": 2,
            "causeId": 5,
            "devName": "Inverter-1",
            "devTypeId": 38,
            "esnCode": "Inverter05",
            "lev": 2,
            "raiseTime": 1667179861000,
            "repairSuggestion": "Turn off the AC and DC switches, wait for 5 minutes, and then turn on the AC and DC switches. If the fault persists, contact your dealer or technical support.",
            "stationCode": "NE=33554792",
            "stationName": "hzhStation02",
            "status": 1
        },
        {
            "alarmCause": "1. The voltage of a battery expansion module is low.",
            "alarmId": 3011,
            "alarmName": "Battery expansion module undervoltage",
            "alarmType": 2,
            "causeId": 2,
            "devName": "Inverter-2",
            "devTypeId": 38,
            "esnCode": "Inverter01",
            "lev": 4,
            "raiseTime": 1665264943000,
            "repairSuggestion": "1. If the sunlight is sufficient or AC reverse charging is allowed, the Battery [CNo] battery expansion module [SNo] (in the fault location information) can be charged when the inverter is running.",
            "stationCode": "NE=33554785",
            "stationName": "hzhStation01",
            "status": 1
        }
    ],
    "failCode": 0,
    "message": null,
    "params": {
        "currentTime": 1667399432812,
        "sns": "Inverter01",
        "language": "zh_CN",
        "beginTime": 1664553600000,
        "devTypes": "1,2,38,46,62",
        "endTime": 1667231999000,
        "levels": "1,2,3,4",
        "stationCodes": "NE=33554785,NE=33554792"
    },
    "success": true
}
```

### Response Example (Error)
```json
{
    "data": null,
    "failCode": 20055,
    "message": null,
    "params": {
        "currentTime": 1667399781133,
        "sns": "",
        "language": "zh_CN",
        "beginTime": 1664553600000,
        "devTypes": "1,2,38,46,62",
        "endTime": 1667231999000,
        "levels": "1,2,3,4",
        "stationCodes": ""
    },
    "success": false
}
```

### Access Restrictions
Prerequisites for obtaining data: The user has the permission to access this interface.
```

--------------------------------

### Logout Interface Successful Response Example

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/2cbb1384/logout-interface

This example shows a successful response from the logout interface. A 'success' flag of true and 'failCode' of 0 indicate the operation was successful.

```json
{
    "success":true,
    "data":null,
    "failCode":0,
    "params":{
        "currentTime":1503046597854
    },
    "message":null
}
```

--------------------------------

### Logout Interface Failed Response Example

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/2cbb1384/logout-interface

This example illustrates a failed response from the logout interface. A 'success' flag of false and a non-zero 'failCode' (e.g., 20001) indicate an error occurred.

```json
{
    "data":null,
    "success":false,
    "failCode":20001,
    "params":{
        "currentTime":1503046597854
    },
    "message":null
}
```

--------------------------------

### Login Interface Request Example

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/9e1a18d2/login-interface

This snippet shows the JSON payload for a login request to the iMaster NetEco system. It includes the username and system code (password).

```json
{
    "userName":"*******",
    "systemCode":"*******"
}
```

--------------------------------

### Device Alarm Interface Response Example - Error

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/9977dccb/device-alarm-interface

This response example illustrates an error scenario where a specific failCode is returned, indicating an issue with the request or data retrieval.

```json
{
    "data": null,
    "failCode": 20055,
    "message": null,
    "params": {
        "currentTime": 1667399781133,
        "sns": "",
        "language": "zh_CN",
        "beginTime": 1664553600000,
        "devTypes": "1,2,38,46,62",
        "endTime": 1667231999000,
        "levels": "1,2,3,4",
        "stationCodes": ""
    },
    "success": false
}
```

--------------------------------

### Device Alarm Interface Request Example

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/9977dccb/device-alarm-interface

This is an example of a request payload for the device alarm interface. It specifies station codes, device serial numbers, time ranges, language, alarm levels, and device types.

```json
{
    "stationCodes":"NE=33554785,NE=33554792",
    "sns":"Inverter01",
    "beginTime":"1664553600000",
    "endTime":"1667231999000",
    "language":"zh_CN",
    "levels":"1,2,3,4",
    "devTypes":"1,2,38,46,62"
}
```

--------------------------------

### Get Plant List

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/4217ab29/plant-list-interface

Retrieves a list of plants based on specified criteria. Supports pagination and time range filtering for grid connection dates.

```APIDOC
## GET /plant-list

### Description
Retrieves a list of plants with optional filtering by grid connection time range and pagination.

### Method
GET

### Endpoint
/plant-list

### Parameters
#### Query Parameters
- **pageNo** (integer) - Optional - The page number for pagination.
- **gridConnectedStartTime** (long) - Optional - The start timestamp (in milliseconds) for filtering by grid connection time.
- **gridConnectedEndTime** (long) - Optional - The end timestamp (in milliseconds) for filtering by grid connection time.

### Request Example
```json
{
  "pageNo": 1,
  "gridConnectedStartTime": 1664718569000,
  "gridConnectedEndTime": 1667396969000
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the plant list data if successful.
  - **list** (array) - An array of plant objects.
    - **plantCode** (string) - The unique code of the plant.
    - **plantName** (string) - The name of the plant.
    - **plantAddress** (string) - The address of the plant (can be null).
    - **longitude** (number) - The longitude coordinate of the plant (can be null).
    - **latitude** (number) - The latitude coordinate of the plant (can be null).
    - **capacity** (number) - The capacity of the plant.
    - **contactPerson** (string) - The contact person for the plant.
    - **contactMethod** (string) - The contact method for the plant.
    - **gridConnectionDate** (string) - The date of grid connection in ISO 8601 format.
  - **pageCount** (integer) - The total number of pages.
  - **pageNo** (integer) - The current page number.
  - **pageSize** (integer) - The number of items per page.
  - **total** (integer) - The total number of plants.
- **failCode** (integer) - The error code if the request failed (0 for success).
- **message** (string) - A message describing the result of the request.

#### Response Example (Success)
```json
{
  "success": true,
  "data": {
    "list": [
      {
        "plantCode": "NE=12345678",
        "plantName": "NMplant1",
        "plantAddress": null,
        "longitude": null,
        "latitude": null,
        "capacity": 146.5,
        "contactPerson": "",
        "contactMethod": "",
        "gridConnectionDate": "2022-11-21T16:23:00+08:00"
      },
      {
        "plantCode": "NE=23456789",
        "plantName": "plant2",
        "plantAddress": null,
        "longitude": null,
        "latitude": null,
        "capacity": 123.3,
        "contactPerson": "",
        "contactMethod": "",
        "gridConnectionDate": "2022-11-21T16:30:28-12:00"
      }
    ],
    "pageCount": 1,
    "pageNo": 1,
    "pageSize": 100,
    "total": 2
  },
  "failCode": 0,
  "message": "get plant list success"
}
```

#### Error Response (e.g., 400)
- **success** (boolean) - Always false for errors.
- **data** (null) - Null when an error occurs.
- **failCode** (integer) - The specific error code.
- **message** (string) - A message describing the error.

#### Response Example (Error)
```json
{
  "success": false,
  "data": null,
  "failCode": 20605,
  "message": "The time cannot be a negative number."
}
```
```

--------------------------------

### Get Alarm List

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/9977dccb/device-alarm-interface

Retrieves a list of alarms based on specified criteria. Users can filter alarms by plant, device, time, severity, and type.

```APIDOC
## POST /thirdData/getAlarmList

### Description
Retrieves a list of alarms for devices within a specified time range and optionally filtered by plant, device SN, severity, and device type.

### Method
POST

### Endpoint
https://_Domain name of the management system_/thirdData/getAlarmList

### Parameters
#### Query Parameters
- **stationCodes** (String) - Optional - Plant ID list. Multiple plant IDs are separated by commas (,). Plant IDs are obtained from **plantCode** in Plant List Interface. At least one of the **stationCodes** and **sns** parameters must be set. If both parameters are set, alarms are queried by **stationCodes**.
- **sns** (String) - Optional - Device SN list. Multiple device SNs are separated by commas (,). At least one of the **stationCodes** and **sns** parameters must be set. If both parameters are set, alarms are queried by **stationCodes**.
- **beginTime** (Long) - Mandatory - Query start time, in milliseconds
- **endTime** (Long) - Mandatory - Query end time, in milliseconds
- **language** (String) - Mandatory - Language. The value must be**zh_CN** , **en_US** , **ja_JP** , **it_IT** , **nl_NL** , **pt_BR** , **de_DE** , **fr_FR** , **es_ES** , or **pl_PL**. zh_CN: Chinese en_US: English ja_JP: Japanese it_IT: Italian nl_NL: Dutch pt_BR: Portuguese de_DE: German fr_FR: French es_ES: Spanish pl_PL: Polish
- **levels** (String) - Optional - Alarm severity. Multiple alarm severities are separated by commas (,), for example, **1,2**. If this parameter is not transferred or is left empty, alarms of all severities are queried by default. The following alarm severities are supported: 1: critical 2: major 3: minor 4: warning
- **devTypes** (String) - Optional - Device type. Multiple device types are separated by commas (,), for example, **1,38**. If this parameter is not transferred or is left empty, alarms of all device types are queried by default. The following device types are supported: 1: string inverter 2: SmartLogger 8: STS 10: EMI 13: protocol converter 16: general device 17: grid meter 22: PID 37: Pinnet data logger 38: residential inverter 39: battery 40: backup box 45: PLC 46: optimizer 47: power sensor 62: Dongle 63: distributed SmartLogger 70: safety box

### Access Restrictions
Traffic limiting is performed based on the number of plants managed by northbound API users and the number of devices of each type.
Number of northbound API calls per user every 30 minutes = MAX (Roundup (Number of plants/100),∑ Roundup (Number of devices of each type/100))
If the access frequency exceeds the limit, the interface returns error code 407.
```

--------------------------------

### Query Plant List

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/4217ab29/plant-list-interface

Retrieves a paginated list of plants. Supports filtering by grid connection time. Pagination parameters are mandatory, and grid connection times are optional.

```APIDOC
## Query Plant List

### Description
This interface is used to query the plant list. When the pagination parameters (a maximum of 100 records can be displayed on each page) and grid connection time are transferred (if only the grid connection start time is transferred, the grid connection end time is the current time by default; if only the grid connection end time is transferred, the default grid connection start time is 1970-01-01 08:00:00), the plant list is queried in pages based on the grid connection time. When only the pagination parameter is transferred, the plant list is queried in pages.

### Method
POST

### Endpoint
https://_Domain name of the management system_/thirdData/stations

### Parameters
#### Query Parameters
- **pageNo** (Integer) - Mandatory - Page No. of the results
- **gridConnectedStartTime** (Long) - Optional - Grid connection start time (ms)
- **gridConnectedEndTime** (Long) - Optional - Grid connection end time (ms)

### Response
#### Success Response (200)
- **success** (Boolean) - Request success or failure flag
- **failCode** (Integer) - Error code
- **message** (string) - Optional response message
- **data** (Map) - Returned data, which contains the following information:
  - **total** (Long) - Total number of results
  - **pageCount** (Long) - Total number of pages
  - **pageNo** (Integer) - Page No. of the results
  - **pageSize** (Integer) - Number of query results displayed on each page
  - **list** (List) - Plant information list, where each item contains:
    - **plantCode** (String) - Plant ID
    - **plantName** (String) - Plant name
    - **plantAddress** (String) - Detailed address of the plant
    - **longitude** (Double) - Plant longitude
    - **latitude** (Double) - Plant latitude
    - **capacity** (Double) - Total string capacity in kWp
    - **contactPerson** (String) - Plant contact
    - **contactMethod** (String) - Contact information of the plant contact
    - **gridConnectionDate** (String) - Grid connection time of the plant (e.g., 2020-02-06T00:00:00+08:00)
```

--------------------------------

### Login Interface

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/9e1a18d2/login-interface

This interface must be invoked before obtaining data to retrieve the XSRF-TOKEN. The token is valid for 30 minutes and can be reused if not expired. A new token is required upon expiration. The XSRF-TOKEN is returned in the response header upon successful login.

```APIDOC
## Login Interface

### Description
Before obtaining data, the login interface must be invoked to obtain the XSRF-TOKEN. The validity period of XSRF-TOKEN is 30 minutes. If the XSRF-TOKEN does not expire, it can be reused. If the XSRF-TOKEN has expired, the login interface needs to be invoked again to obtain a new XSRF-TOKEN. After this interface is invoked to log in to the system, XSRF-TOKEN is returned in the response header.

### Method
POST

### Endpoint
https://Domain name of the management system/thirdData/login

### Access Restrictions
If a user enters incorrect passwords for five consecutive times within 10 minutes, the user will be locked out for 30 minutes.
Number of traffic limiting times for each northbound user: five times every 10 minutes.
If the access frequency exceeds the limit, the interface returns error code 407.

### Parameters
#### Request Body
- **userName** (String) - Mandatory - Username
- **systemCode** (String) - Mandatory - Password

### Request Example
```json
{
    "userName":"*******",
    "systemCode":"*******"
}
```

### Response
#### Success Response (200)
- **success** (Boolean) - Request success or failure flag true: The request succeeded. false: The request failed.
- **failCode** (Integer) - Error code 0 indicates that the status is normal. For definitions of other error codes, see Error Code List.
- **params** (-) - -
- **currentTime** (Long) - Current system time, in milliseconds
- **message** (String) - Optional message
- **data** (Object) - Returned data

#### Response Example (Successful Login)
```json
{
    "success":true,
    "data":null,
    "failCode":0,
    "params":null,
    "message":null
}
```

#### Response Example (Failed Login)
```json
{
    "data":null,
    "failCode":20001,
    "message":"",
    "params":{
        "currentTime":1593777870514
    },
    "success":false
}
```

**Note:** The header of the login success response contains the XSRF-TOKEN that must be retained. In subsequent data interface requests, this parameter and its value must be added to the request header and sent to the management system.
```

--------------------------------

### Plant List Interface

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/4217ab29/plant-list-interface

Retrieves a list of plants. This interface is supported in iMaster NetEco V600R023C00SPC210 and later versions. For earlier versions, refer to the Historical Interfaces section.

```APIDOC
## Plant List Interface

### Description
Retrieves a list of plants. This interface is available in iMaster NetEco V600R023C00SPC210 and later versions. For versions earlier than iMaster NetEco V600R023C00SPC210, use the Plant List Interface found in the Historical Interfaces section.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
(Not specified in source)

### Request Example
(Not specified in source)

### Response
#### Success Response (200)
(Not specified in source)

#### Response Example
(Not specified in source)
```

--------------------------------

### Logout Interface

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/2cbb1384/logout-interface

This interface allows you to expire the XSRF-TOKEN immediately. It is recommended to invoke this only when necessary due to traffic limiting restrictions.

```APIDOC
## Logout Interface

### Description
If you want the XSRF-TOKEN to expire immediately, you can invoke this interface.

### Method
POST

### Endpoint
https://Domain name of the management system/thirdData/logout

### Parameters
#### Request Body
- **xsrfToken** (String) - Mandatory - XSRF-TOKEN returned in the response header after a successful login through the login interface.

### Request Example
```json
{
    "xsrfToken":"x-apepjy1fpd2ptete1f7zuqimep7wuqen9hkb3xaourelbyrx9jio7s09hgk6ca2mdlksjdglasdhjaklsdfhhdsahwedyuioqwehjkd"
}
```

### Response
#### Success Response (200)
- **success** (Boolean) - Request success or failure flag true: The request succeeded. false: The request failed.
- **failCode** (Integer) - Error code 0 indicates that the status is normal. For definitions of other error codes, see Error Code List.
- **params** (Object) - Parameters
  - **currentTime** (Long) - Current system time, in milliseconds
- **message** (String) - Optional message
- **data** (Object) - Returned data

#### Response Example
Example 1: successful logout
```json
{
    "success":true,
    "data":null,
    "failCode":0,
    "params":{
        "currentTime":1503046597854
    },
    "message":null
}
```
Example 2: failed logout
```json
{
    "data":null,
    "success":false,
    "failCode":20001,
    "params":{
        "currentTime":1503046597854
    },
    "message":null
}
```
```

--------------------------------

### Device Alarm Response Packet

Source: https://support.huawei.com/enterprise/en/doc/EDOC1100261860/9977dccb/device-alarm-interface

This section details the structure of the response packet returned by the device alarm interface. It includes fields for request status, error codes, and a list of alarm data.

```APIDOC
## Response Packet

### Description
Details the structure of the response packet for device alarm queries.

### Parameters
#### Response Body Fields
- **success** (Boolean) - Required - Request success or failure flag. `true`: The request succeeded. `false`: The request failed.
- **failCode** (Integer) - Required - Error code. Value `0` indicates that the status is normal. For definitions of other error codes, see Error Code List.
- **params** (Object) - Optional - Parameters sent in the request.
  - **stationCodes** (String) - Optional - Plant ID list in the request parameter.
  - **sns** (String) - Optional - Device SN list in the request parameter.
  - **beginTime** (Long) - Optional - Start time in the request parameter, in milliseconds.
  - **endTime** (Long) - Optional - End time in the request parameter, in milliseconds.
  - **language** (String) - Optional - Language in the request parameter.
  - **levels** (String) - Optional - Alarm severity in the request parameter.
  - **devTypes** (String) - Optional - Device type in the request parameter.
- **currentTime** (Long) - Required - Current system time, in milliseconds.
- **message** (String) - Optional - Optional message.
- **data** (List) - Required - Returned data. The data contains the alarm information list.
  - **stationCode** (String) - Required - Plant ID, which uniquely identifies a plant.
  - **alarmName** (String) - Required - Alarm name.
  - **devName** (String) - Required - Device name.
  - **repairSuggestion** (String) - Optional - Solution.
  - **esnCode** (String) - Required - Device SN.
  - **devTypeId** (Integer) - Required - Device type ID. Supported types: 1: string inverter, 2: SmartLogger, 8: STS, 10: EMI, 13: protocol converter, 16: general device, 17: grid meter, 22: PID, 37: Pinnet data logger, 38: residential inverter, 39: battery, 40: backup box, 45: PLC, 46: optimizer, 47: power sensor, 62: Dongle, 63: distributed SmartLogger, 70: safety box.
  - **causeId** (Integer) - Required - Cause ID.
  - **alarmCause** (String) - Required - Alarm cause.
  - **alarmType** (Integer) - Required - Alarm type. Supported types: 1: transposition signal, 2: exception alarm, 3: protection event, 4: notification status, 5: alarm information.
  - **raiseTime** (Long) - Required - Alarm generation time in milliseconds.
  - **alarmId** (Integer) - Required - Alarm ID.
  - **stationName** (String) - Required - Plant name.
  - **lev** (Integer) - Required - Alarm severity. Supported severities: 1: critical, 2: major, 3: minor, 4: warning.
  - **status** (Integer) - Required - Alarm status. Supported states: 1: not processed (active).
```
Tokens:
Raw