更新升级批次 - 联犀-things

请求参数

Header 参数

Ithings-Project-Id

string

可选

默认值:

Ithings-Token

string

可选

默认值:

app-code

string

可选

默认值:

device-id

string

可选

用户正在使用的设备ID(小程序,ios,安卓的设备ID)

Body 参数application/json

id

integer <int64>

可选

firmwareID

integer <int64>

可选

升级包ID，升级包的唯一标识符。

type

integer <int64>

可选

升级包所属产品的JobType。验证升级包:1 批量升级:2

<= 2

status

integer <int64>

可选

批次状态,计划中:1 执行中:2 已完成:3 已取消:4

<= 4

upgradeType

integer <int64>

可选

升级策略，1-静态，2-动态

<= 2

srcVersions

array[string]

可选

待升级版本号列表。最多可传入10个版本号。用逗号分隔多个版本号

retryInterval

integer <int64>

可选

设备升级失败后，自动重试的时间间隔，单位为分钟。动态升级静态升级

retryCount

integer <int64>

可选

自动重试次数。1/2/5次动态升级静态升级

timeoutInMinutes

integer <int64>

可选

设备升级超时时间，单位为分钟。动态升级静态升级

maximumPerMinute

integer <int64>

可选

每分钟最多向多少个设备推送升级包下载URL。动态升级静态升级

isOverwriteMode

integer <int64>

可选

是否覆盖之前的升级任务。取值：2（不覆盖）、1（覆盖）。

<= 2

isNeedPush

integer <int64>

可选

物联网平台是否主动向设备推送升级任务。

<= 2

isNeedConfirm

integer <int64>

可选

<= 2

target

string

可选

分组升级和区域升级填写对应的id

targetSelection

integer <int64>

可选

升级范围。 1：全量升级。 2：定向升级。 3：灰度升级。 4：分组升级(不做) 5: 区域升级(不做)

<= 4

tenantCodes

array[string]

指定租户

可选

createdTime

integer <int64>

可选

dynamicMode

integer <int64>

可选

<= 2

targetDeviceNames

array[string]

可选

定向升级的设备名称列表。最多可传入200个设备名称。以逗号分隔

scheduleFinishTime

integer <int64>

可选

指定结束升级的时间，单位为毫秒。

scheduleTime

integer <int64>

可选

grayPercent

integer <int64>

可选

灰度的范围,小数点后两位, 1.23%为 123

示例

{
  "id": 0,
  "firmwareID": 0,
  "type": 2,
  "status": 4,
  "upgradeType": 2,
  "srcVersions": [
    "string"
  ],
  "retryInterval": 0,
  "retryCount": 0,
  "timeoutInMinutes": 0,
  "maximumPerMinute": 0,
  "isOverwriteMode": 2,
  "isNeedPush": 2,
  "isNeedConfirm": 2,
  "target": "string",
  "targetSelection": 4,
  "tenantCodes": [
    "string"
  ],
  "createdTime": 0,
  "dynamicMode": 2,
  "targetDeviceNames": [
    "string"
  ],
  "scheduleFinishTime": 0,
  "scheduleTime": 0,
  "grayPercent": 0
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v1/things/ota/firmware/job/update' \
--header 'Ithings-Project-Id: {{Ithings-Project-Id}}' \
--header 'Ithings-Token: {{iThings-token}}' \
--header 'app-code: {{appCode}}' \
--header 'device-id;' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

A successful response.

Body

code

integer

返回code

可选

默认值:

200

msg

string

返回的消息

可选

示例

{
  "code": "200",
  "msg": "string"
}