Documentation

Upstream Message Interface Format

The format of the message sent by MindEdge OM to the central NMS is defined as follows:

{
    "header": {
        "msg_id": "584a2d50-11d1-4d60-83ce-f0cc48a45348",
        "parent_msg_id": "",
        "timestamp": 1550107087319,
        "sync": false,
        "resourceversion": ""
    },
    "route": {
        "source": "hardware",
        "group": "hub",
        "operation": "query",
        "resource": "websocket/profile_effect"
    },
    "content": {
    }
}

The meaning of each field is as follows:

Attribute

Type

Description

msg_id

string

Unique ID of a message, which is used by the message processor to perform operations such as deduplication and idempotence. The value is in UUID format.

parent_msg_id

string

Parent message of the message. The format is UUID, which can indicate the request/response relationship.

  • For a request message, this field is left blank.
  • For a response message, the value of this field is the same as that of msg_id in the request.

timestamp

int

Message timestamp.

sync

bool

Whether a message is a synchronous message or not. The options are as follows:

  • false: the message is an asynchronous message and no response is returned. The default value is false.
  • true: indicates that the message is a synchronous message and the edge node needs to return a response.

resourceversion

string

This field is an empty string or is not passed.

source

string

Message source, that is, the module that sends the message. Set this field to hardware for messages reported by the ESPManager.

NOTE:

This parameter is reserved. The value can be EdgeManager and controller.

group

string

Message type. For details, see the message group definition.

NOTE:

This parameter is reserved. The value can be resource, twin, hardware, function, and user.

operation

string

Message operation type, which is a character string.

NOTE:

This parameter is reserved. The value can be insert, update, delete, query, and restart.

resource

string

Resource information. For details, see the definition of each interface.

content

json

Message content, which is defined by each component.

If a field does not exist in an upstream or downstream message, the default value of the field is used.

The message groups are defined as follows:

Direction

Name

Description

Cloud Side Processing Software

Edge Side Processing Software

Edge-cloud, cloud-edge

resource

Resource life cycle information and metadata information

EdgeManager, DeviceManager

MetaManager, Edged

Edge-cloud, cloud-edge

hardware

Information about interaction with the hardware device management platform

EdgeManager

EventBus

Edge-cloud, cloud-edge

function

Status information of the function on the edge

FunctionManager

MetaManager, Edged

Edge-cloud, cloud-edge

user

User's own data

Users' applications or other cloud services

EventBus