查询指定升级任务子任务详情
典型场景
在创建了设备软件升级任务或固件升级任务后，任务中涉及的每个设备的升级是一个子任务（即升级任务中涉及多少个设备，就有多少个子任务）。第三方应用可调用此接口查询某个升级任务中各个子任务的详细信息，以查看子任务的具体执行情况。
接口功能
支持第三方应用在物联网平台查询单个固件或软件升级任务中每个设备的升级执行情况。
接口描述
1 |
def queryUpgradeSubTask(self, qustInDTO, operationId, accessToken)
|
参数说明
参数 |
必选/可选 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
qustInDTO |
必选 |
QueryUpgradeSubTaskInDTO |
query |
见下表QueryUpgradeSubTaskInDTO的描述。 |
operationId |
必选 |
String |
path |
操作任务ID，在创建操作任务后由物联网平台返回获得。 |
accessToken |
必选 |
String |
header |
填写鉴权接口获取的accessToken。 |
QueryUpgradeSubTaskInDTO
参数 |
必选/可选 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
subOperationStatus |
可选 |
String |
query |
子任务状态，不指定，则查询该任务下所有子任务执行详情。
|
pageNo |
可选 |
Integer |
query |
分页查询参数，默认值“0”。
|
pageSize |
可选 |
Integer |
query |
查询结果分页时的每页结果数量，取值范围1-100，默认值“10”。 |
响应参数
QueryUpgradeSubTaskOutDTO
参数 |
类型 |
描述 |
|---|---|---|
data |
list<SubOperationInfo> |
子任务列表信息，具体参见。 |
pageNo |
long |
查询结果的页码。 |
pageSize |
long |
查询结果每页的记录数量。 |
totalCount |
long |
查询结果的记录总数。 |
SubOperationInfo结构体说明：
参数 |
类型 |
描述 |
|---|---|---|
subOperationId |
String |
子任务ID。 |
createTime |
String |
子任务创建时间。 |
startTime |
String |
子任务启动时间。 |
stopTime |
String |
子任务停止时间。 |
operateType |
String |
操作类型。
|
deviceId |
String |
操作设备的设备ID。 |
status |
String |
子任务状态。
|
detailInfo |
String |
任务状态的详细描述，对于失败场景下为失败原因。 |
extendInfo |
JsonString |
任务扩展信息，视不同类型的操作不同。 |
错误码
Http状态码 |
错误码 |
错误描述 |
说明 |
|---|---|---|---|
400 |
120015 |
Bad request error. |
请求错误。 处理建议：请检查接口请求中fileId的格式是否正确。 |
400 |
123029 |
pageNo or pageSize beyond the limit. |
pageNo或pageSize超出上限。 处理建议：修改pageNo或pageSize为合法取值。 |
403 |
1010009 |
app throttle exceed. |
应用调用接口过于频繁，超过流控值（默认值是100次/60s）。 处理建议：联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。 |
403 |
1010005 |
App_key or access_token is invalid. |
错误的token信息。 处理建议：请检查接口请求中所携带的accessToken是否有误。 |
404 |
123009 |
The requested task does not exist. |
查询的任务不存在。 处理建议：请检查接口请求中的operationId内容是否正确。 |
