1. 接口描述
接口请求域名:
iot.cloud.tencent.com/api/exploreropen/tokenapi
。
本接口(AppDescribeFirmwareUpdateStatus)用于查询设备固件升级状态及进度。2. 输入参数
名称 | 类型 | 必选 | 描述 |
AccessToken | String | 是 | 公共参数,AccessToken 用于对一个已经登录的用户鉴权。 |
RequestId | String | 是 | 公共参数,唯一请求 ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。 |
Action | String | 是 | 公共参数,本接口取值:AppDescribeFirmwareUpdateStatus。 |
ProductId | String | 是 | 产品 ID。 |
DeviceName | String | 是 | 设备名。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。 |
OriVersion | String | 升级任务源版本。 |
DstVersion | String | 升级任务目标版本。 |
ErrMsg | String | 错误信息。 |
Percent | Int64 | 升级进展百分比。 |
Status | Int64 | 升级状态: 0:设备离线。 1:待处理。 2:消息下发成功。 3:下载中。 4:烧录中。 5:失败。 6:升级完成。 7:正在处理中。 8:等待用户确认。 20:下载完成。 |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"RequestId": "f92406b3-5a9a-4fe8-bc43-45e3d794bb68","Action": "AppDescribeFirmwareUpdateStatus","ProductId":"22*******O","DeviceName":"li****1","AccessToken": "8b4d16105f******************18edd4e78a3bb8ec"}
输出示例: 成功
{"Response": {"DstVersion": "2.0","ErrMsg": "","OriVersion": "1.0","Percent": 0,"RequestId": "f92406b3-5a9a-4fe8-bc43-45e3d794bb68"}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidAccessToken | Token 无效。 |