1. 接口描述
接口请求域名： iotexplorer.tencentcloudapi.com 。
获取围栏列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribePositionFenceList。 |
| Version | 是 | String | 公共参数，本接口取值：2019-04-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, eu-frankfurt, na-ashburn 。 |
| SpaceId | 是 | String | 位置空间Id 示例值：5bf5407370cc40848f39a2896a2ab052 |
| Offset | 否 | Integer | 翻页偏移量，0起始 示例值：0 |
| Limit | 否 | Integer | 最大返回结果数 示例值：100 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| List | Array of PositionFenceInfo | 围栏列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | 围栏数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：3 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取围栏列表
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePositionFenceList
<公共请求参数>
{
"SpaceId": "5bf5407370cc40848f39a2896a2ab052",
"Limit": 100
}输出示例
{
"Response": {
"List": [
{
"GeoFence": {
"FenceId": 6,
"SpaceId": "5bf5407370cc40848f39a2896a2ab052",
"FenceName": "TestFence",
"FenceDesc": "TT",
"FenceArea": "{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[113.9498,22.5319],[113.9709,22.5319],[113.9709,22.5723],[113.9498,22.5723],[113.9498,22.5319]]]},\"properties\":null}]}"
},
"CreateTime": 1604030296579,
"UpdateTime": 1604030296579
},
{
"GeoFence": {
"FenceId": 17,
"SpaceId": "5bf5407370cc40848f39a2896a2ab052",
"FenceName": "TestFence1116",
"FenceDesc": "1116",
"FenceArea": "{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[113.9498,22.5319],[113.9709,22.5319],[113.9709,22.5723],[113.9498,22.5723],[113.9498,22.5319]]]},\"properties\":null}]}"
},
"CreateTime": 1605510338840,
"UpdateTime": 1605510338840
},
{
"GeoFence": {
"FenceId": 38,
"SpaceId": "5bf5407370cc40848f39a2896a2ab052",
"FenceName": "TestFence1117",
"FenceDesc": "1117",
"FenceArea": "{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[113.9498,22.5319],[113.9709,22.5319],[113.9709,22.5723],[113.9498,22.5723],[113.9498,22.5319]]]},\"properties\":null}]}"
},
"CreateTime": 1605584593250,
"UpdateTime": 1605584593250
}
],
"RequestId": "f7b5e3e8-5089-4f11-b999-9a4c5952c4c5",
"Total": 3
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.InternalRPCError | 内部RPC错误。 |
| InternalError.InternalServerExceptionDB | 内部DB错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound.SpaceNotExist | 位置空间未创建或是已删除。 |
| UnauthorizedOperation | 未授权操作。 |
