1. 接口描述
接口请求域名:
iot.cloud.tencent.com/api/exploreropen/tokenapi
。
本接口(AppGetDeviceOTAInfo)用于查询设备固件下载地址。2. 输入参数
名称 | 类型 | 必选 | 描述 |
AccessToken | String | 是 | 公共参数,AccessToken 用于对一个已经登录的用户鉴权。 |
RequestId | String | 是 | 公共参数,唯一请求 ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。 |
Action | String | 是 | 公共参数,本接口取值:AppGetDeviceOTAInfo。 |
ProductId | String | 是 | 产品 ID。 |
DeviceName | String | 是 | 设备名称。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。 |
FirmwareURL | String | 固件下载地址。 |
TargetVersion | String | 目标固件版本。 |
UploadVersion | String | 设备上报的固件版本。 |
4. 示例
示例1
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"AccessToken": "871d2d42****************692afae0","Action": "AppGetDeviceOTAInfo","RequestId": "584406e9-bf59-46a3-8d45-39f1891bed7b","ProductId": "PR******ID","DeviceName": "de***01",}
输出示例: 成功
{"Response": {"FirmwareURL": "https://examplebucket-12500000000.cos.ap-guangzhou.myqcloud.com/path/to/firmware?sign=***","RequestId": "584406e9-bf59-46a3-8d45-39f1891bed7b","TargetVersion": "1.1","UploadVersion": "1.0"}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidAccessToken | Token 无效。 |
InvalidParameterValue.NoPermission | 用户对该设备无权限。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.DeviceFirmwareTaskNotExist | 未查询到固件升级任务。 |