物联网开发平台
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 物联网开发平台 > API 文档 > 位置服务相关接口 > 获取位置空间中围栏告警事件列表

获取位置空间中围栏告警事件列表

最近更新时间：2024-03-12 01:34:23

我的收藏

本页目录：

1. 接口描述

接口请求域名： iotexplorer.tencentcloudapi.com 。

获取位置空间中围栏告警事件列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeSpaceFenceEventList。
Version 是 String 公共参数，本接口取值：2019-04-23。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, eu-frankfurt, na-ashburn 。
SpaceId 是 String 位置空间Id
示例值：fccea82eb28b4943b654a35ce9dd5952
StartTime 是 Integer 围栏告警信息的查询起始时间，Unix时间，单位为毫秒
示例值：1579572927008
EndTime 是 Integer 围栏告警信息的查询结束时间，Unix时间，单位为毫秒
示例值：1611108927008
Offset 否 Integer 翻页偏移量，0起始
示例值：0
Limit 否 Integer 最大返回结果数
示例值：10

3. 输出参数

参数名称 类型 描述
List Array of FenceEventItem 围栏告警事件列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：[{ "ProductId": "X4912BAIVR", "DeviceName": "dev1", "FenceId"
Total Integer 围栏告警事件总数
示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeSpaceFenceEventList

获取位置空间下围栏告警事件列表

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSpaceFenceEventList
<公共请求参数>

{
    "SpaceId": "5bf5407370cc40848f39a2896a2ab052",
    "StartTime": 1604030050000,
    "EndTime": 1604039050000,
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "List": [
            {
                "ProductId": "X4912BAIVR",
                "DeviceName": "dev1",
                "FenceId": 6,
                "AlertType": "In",
                "Data": {
                    "AlarmTime": 1604034069575,
                    "Longitude": 113.95,
                    "Latitude": 22.55782
                }
            }
        ],
        "RequestId": "1e99faaf-a0f0-4c49-9d85-7f09f2b7f74e",
        "Total": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
InternalError 内部错误。
InternalError.InternalRPCError 内部RPC错误。
InternalError.InternalServerExceptionDB 内部DB错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.StartTimeLaterEndTime 开始时间晚于结束时间。
ResourceNotFound.SpaceNotExist 位置空间未创建或是已删除。
UnauthorizedOperation 未授权操作。
中国站