物联网开发平台获取设备位置列表-位置服务相关接口-API 中心-腾讯云

1. 接口描述

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

获取设备位置列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDevicePositionList。
Version	是	String	公共参数，本接口取值：2019-04-23。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-bangkok, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, eu-frankfurt, na-ashburn 。
ProductIdList.N	是	Array of String	产品标识列表示例值：["X4912BAIVR"]
CoordinateType	否	Integer	坐标类型示例值：3
Offset	否	Integer	分页偏移示例值：0
Limit	否	Integer	分页的大小示例值：100

3. 输出参数

参数名称	类型	描述
Positions	Array of ProductDevicesPositionItem	产品设备位置信息列表
Total	Integer	产品设备位置信息的数目示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备位置列表

输入示例

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

{
    "ProductIdList": [
        "X4912BAIVR"
    ],
    "CoordinateType": 3,
    "Offset": 0,
    "Limit": 100
}

输出示例

{
    "Response": {
        "Positions": [
            {
                "ProductId": "X4912BAIVR",
                "Items": [
                    {
                        "DeviceName": "dev1",
                        "CreateTime": 1600260759000,
                        "Longitude": 113.9709,
                        "Latitude": 22.562782
                    }
                ],
                "Total": 1
            }
        ],
        "RequestId": "f58e6eab-ffcb-425d-94ac-f14047d93609",
        "Total": 1
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.InternalRPCError	内部RPC错误。
InvalidParameterValue.ProductIDInvalid	产品ID非法。