Upgrading the Software

Function

Delivers the MEF Edge software upgrade message.

Syntax

Operation type: POST

URL: https://{ip}:{port}/edgemanager/v1/software/edge/upgrade

Request message body:
{
    "SerialNumbers": ["xxxxxxxxxxxxx"],
    "softwareName": "MEFEdge"
}

Request Parameters

Table 1 Description

Parameter

Mandatory/Optional

Description

Value

SerialNumbers

Mandatory

Device SN

Array with a maximum length of 64 bytes, which can contain lowercase letters, uppercase letters, digits, underscores (_), and hyphens (-). The value cannot start or end with an underscore (_) or hyphen (-). The value contains 1 to 2048 characters.

softwareName

Mandatory

Name of the software to be downloaded

The value is MEFEdge.

Usage Example

Request:
POST https://10.10.10.10:30035/edgemanager/v1/software/edge/upgrade

Request message body:

{
    "SerialNumbers": ["xxxxxxxxxxxxx"],
    "softwareName": "MEFEdge"
}

Response:

{
    "status": "00000000",
    "msg": "success",
    "data": {
        "failedInfos": {},
        "successIDs": [
            "xxxxxxxxxxxxxx"
        ]
    }
}

Response status code: 200

Output Description

Table 2 Operation output description

Parameter

Type

Description

status

String

Error code

msg

String

Description

data

Object

-

Table 3 data field description

Parameter

Type

Description

successIDs

String list

IDs that successfully upgrade the software.

failedInfos

Hash table. The key and value are character strings.

key is the IDs that fail to upgrade the software, and value is the failure cause.