1. 接口描述
接口请求域名:
iot.cloud.tencent.com/api/exploreropen/serviceapi
。
本接口(ServiceReportDeviceState)用于设备状态上报。2. 输入参数
名称 | 类型 | 必选 | 描述 |
Action | String | 是 | 公共参数,本接口取值:ServiceReportDeviceState。 |
RequestId | String | 是 | 公共参数,唯一请求ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。 |
AppKey | String | 是 | 公共参数,物联网 SaaS 的 AppKey ,用于标识对应的物联网 SaaS。 |
Signature | String | 是 | 公共参数,请求签名,需用户自行生成,用于校验请求的合法性。 |
Timestamp | Int64 | 是 | 公共参数,请求的 Unix 时间戳(秒级)。 |
Nonce | Int | 是 | 公共参数,随机正整数,与 Timestamp 联合起来,防止重放攻击。 |
DeviceId | String | 是 | 在物联网开发平台创建的设备 ID,唯一标识一个设备,由 产品ID + "/" + 设备名称 组合而成,例如 ProductABC/Device001 。 |
OnlineStatus | Int | 是 | 设备状态。 0:离线 1:在线 2:未知 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。 |
Status | String | 请求结果,成功时返回此字段,返回值为 OK。 |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/serviceapi HTTP/1.1content-type: application/json{"RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68","Timestamp": 1599468019,"Nonce": 170533123,"AppKey": "AppKey","Signature": "Signature","Action": "ServiceReportDeviceState","OnlineStatus": 1,"DeviceId": "ProductId/DeviceName"}
输出示例:成功
{"Response": {"RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68","Status": "OK"}}
输出示例:失败
{"Response": {"Error": {"Code": "InvalidParameterValue","Message": "Signature 无效"},"RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68"}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
ErrorRequiredParamNotFound | 必选参数缺失。 |
InvalidAction | Action 非法。 |
InvalidParameterValue | 参数非法。 |
InvalidParameterValue.InvalidJSON | 请求格式不是 JSON。 |