发起设备固件升级

POST

/openapi/v0.9/manage/api/v1/organizations/{org_uuid}/devices/ota

es-management-service

发起指定设备的固件升级任务

请求参数

Path 参数

org_uuid

string

组织UUID

必需

示例值:

4dbc6ef2-0e3c-4d47-8b32-552a44f573c5

Header 参数

x-user-token

string

必需

默认值:

X-Request-Id

string

可选

默认值:

{% mock 'uuid' %}

Body 参数application/json

devices

array[object (cloudbus.OtaInputDeviceItem) {3}]

必需

设备列表
required: true

firmware_upgrade_type

enum<integer>

固件升级类型

必需

枚举值:

123

product_version

string

必需

产品版本
example: v01.00.0000

string

设备SN

必需

示例

{
    "devices": [
        {
            "firmware_upgrade_type": 1,
            "product_version": "01.00.03",
            "sn": "8UUDMAQBs78131"
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/openapi/v0.9/manage/api/v1/organizations/4dbc6ef2-0e3c-4d47-8b32-552a44f573c5/devices/ota' \
--header 'x-user-token;' \
--header 'X-Request-Id: {% mock '\''uuid'\'' %}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "devices": [
        {
            "firmware_upgrade_type": 1,
            "product_version": "01.00.03",
            "sn": "8UUDMAQBs78131"
        }
    ]
}'

返回响应

🟢200成功

application/json

成功响应

Body

HTTP响应模板

code

integer

响应码

可选

message

string

响应消息

可选

data

object

dto.OtaRsp

可选

响应数据

bid

string

可选

业务ID
example: bid123456

device_code

integer

可选

设备错误码
example: 0

devices

array[object (cloudbus.OtaInputDeviceItem) {3}]

设备列表

可选

status

string

可选

状态
example: success

示例

{
    "code": 0,
    "message": "OK",
    "data": {
        "bid": "518cda54-6d98-4730-acc2-1e49cea34719",
        "device_code": 0,
        "devices": [
            {
                "firmware_upgrade_type": 13,
                "product_version": "01.00.03",
                "sn": "8UUDMBS78A0131"
            }
        ],
        "status": "in_progress"
    }
}

修改于 2025-06-27 12:02:20

[固件管理]查询设备固件升级进度

[固件管理]获取固件兼容配置