1. 接口描述
接口请求域名：
iot.cloud.tencent.com/api/exploreropen/tokenapi。
本接口（AppCreateFence）用于创建设备地理围栏。2. 输入参数
名称 | 类型 | 必选 | 描述 |
AccessToken | String | 是 | 公共参数，AccessToken 用于对一个已经登录的用户鉴权。 |
RequestId | String | 是 | 公共参数，唯一请求 ID，可自行生成，推荐使用 uuId。定位问题时，需提供该次请求的 RequestId。 |
Action | String | 是 | 公共参数，本接口取值：AppCreateFence。 |
ProductId | String | 是 | 产品 ID。 |
DeviceName | String | 是 | 设备名称。 |
FenceName | String | 是 | 设备地理围栏名称。 |
FenceArea | String | 是 | 设备地理围栏区域范围。 |
FenceDesc | String | 是 | 设备地理围栏描述。 |
AlertCondition | String | 是 | 触发条件。 |
FenceEnable | Boolean | 是 | 启用状态。 |
Method | String | 是 | 通知方式。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数，唯一请求 ID，与入参相同，定位问题时，需提供该次请求的 RequestId。 |
FenceId | string | 设备地理围栏 ID。 |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"RequestId": "req_1","Action": "AppCreateFence","ProductId":"NJ****T4","DeviceName":"g****v","FenceName":"appFence","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}]}","FenceDesc": "test","AlertCondition":"leave","FenceEnable": true,"Method":"app push","AccessToken": "8b4a70dd16105f******************18edd4e78a3bb8ec"}
输出示例: 成功
{"Response": {"FenceId":7,"RequestId": "req_1"}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
InternalError.InternalServerExceptionDB | DB 错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidAccessToken | Token 无效。 |
InvalidParameterValue.NoPermission | 用户对该设备无权限。 |
UnauthorizedOperation | 无权操作。 |
UnauthorizedOperation.APPNoPermissionToStudioProduct | App 对操作该产品无权限。 |
UnauthorizedOperation.FenceDupKeyExist | 存在重复围栏。 |
UnauthorizedOperation.SpaceDupKeyExist | 存在重复位置空间。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.StudioProductNotExist | 产品尚未创建或已被删除 |
