1. 接口描述
接口请求域名:
iot.cloud.tencent.com/api/exploreropen/tokenapi
。
本接口(AppGetFenceEventList)用于获取设备地理围栏告警事件列表。2. 输入参数
名称 | 类型 | 必选 | 描述 |
AccessToken | String | 是 | 公共参数,AccessToken 用于对一个已经登录的用户鉴权。 |
RequestId | String | 是 | 公共参数,唯一请求 ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。 |
Action | String | 是 | 公共参数,本接口取值:AppGetFenceEventList。 |
FenceId | Int64 | 是 | 设备地理围栏 ID。 |
ProductId | String | 是 | 产品 ID。 |
DeviceName | String | 是 | 设备名称。 |
FenceEnable | Boolean | 是 | 启用状态。 |
StartTime | Int | 是 | 起始时间(Unix 时间戳,秒级), 为0表示当前时间-24h。 |
EndTime | Int | 是 | 结束时间(Unix 时间戳,秒级), 为0表示当前时间。 |
Offset | Int | 否 | 默认值为0,消息偏移量。 |
Limit | Int | 否 | 默认值为0,最大返回消息条数,最大值为 50。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。 |
List | 设备地理围栏告警事件列表。 |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"RequestId": "req_1","Action": "AppGetFenceEventList","ProductId": "NJ2****ZT4","FenceId": 8,"DeviceName":"g****","StartTime": 1604307550000,"EndTime": 1604309654000,"FenceEnable": true,"Offset": 0,"Limit": 10,"AccessToken": "8b4a70dd16105f******************18edd4e78a3bb8ec"}
输出示例: 成功
{"Response": {"List": [{"EventType": "enter""CreateTime": 1604314065}],"RequestId": "req_1"}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
InternalError.InternalServerExceptionDB | DB 错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidAccessToken | Token 无效。 |
InvalidParameterValue.NoPermission | 用户对该设备无权限。 |
UnauthorizedOperation | 无权操作。 |
UnauthorizedOperation.APPNoPermissionToStudioProduct | App 对操作该产品无权限。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.StudioProductNotExist | 产品尚未创建或已被删除。 |
ResourceNotFound.FenceNotExist | 围栏未创建或是已删除。 |