1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
获取设备历史位置
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetDeviceLocationHistory。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, eu-frankfurt, na-ashburn 。 |
ProductId | 是 | String | 产品Id 示例值:X4912BAIVR |
DeviceName | 是 | String | 设备名 示例值:dev1 |
StartTime | 是 | Integer | 查询起始时间,Unix时间,单位为毫秒 示例值:1604890314000 |
EndTime | 是 | Integer | 查询结束时间,Unix时间,单位为毫秒 示例值:1609890353000 |
CoordinateType | 否 | Integer | 坐标类型 示例值:3 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Positions | Array of PositionItem | 历史位置列表 示例值:[{"CreateTime":1608882530000,"Longitude":113.9709,"Latitude":22. |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 GetDeviceLocationHistory
获取设备历史位置
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetDeviceLocationHistory
<公共请求参数>
{
"ProductId": "X4912BAIVR",
"DeviceName": "dev1",
"StartTime": 1604890314000,
"EndTime": 1609890353000
}
输出示例
{
"Response": {
"Positions": [
{
"CreateTime": 1608882530000,
"Longitude": 113.9709,
"Latitude": 22.562782
},
{
"CreateTime": 1608882530000,
"Longitude": 113.95,
"Latitude": 22.55782
},
{
"CreateTime": 1608890314000,
"Longitude": 113.9,
"Latitude": 22.52782
},
{
"CreateTime": 1608890353000,
"Longitude": 113.95,
"Latitude": 22.55782
}
],
"RequestId": "1e99faaf-a0f0-4c49-9d85-7f09f2b7f74e"
}
}
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错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.StartTimeLaterEndTime | 开始时间晚于结束时间。 |
ResourceNotFound.DeviceNotExist | 设备不存在。 |
ResourceNotFound.ProductNotExist | 产品不存在。 |
ResourceNotFound.StudioProductNotExist | 产品不存在。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.NoPermissionToStudioProduct | 产品ACL错误。 |