GisSearchDeviceTrace

调用该接口查询设备轨迹详情。

使用限制

位置服务相关API自2023年12月01日起仅针对已使用的用户开放,未使用过该服务的用户已暂停开放。

QPS限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为50。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String GisSearchDeviceTrace

系统规定参数。取值:GisSearchDeviceTrace。

DeviceName String mock_device_name

设备名称。

EndTime Long 1645071254000

轨迹结束时间戳(毫秒)。

MapMatch Integer 0

是否结合地图进行位置纠偏。可取值:

  • 0:否,不进行轨迹纠偏。
  • 1:是,进行轨迹纠偏。
ProductKey String g3r****Vjta

要查询设备所属产品的ProductKey。

ProductKey是物联网平台为新建产品颁发的全局唯一标识符。您可以在物联网平台控制台或调用QueryProductList,查看当前账号下所有产品的信息。

StartTime Long 1645071254000

轨迹开始时间戳(毫秒)。

IotInstanceId String iot-a****13l

实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID

重要
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无ID值,则无需传入。

实例的更多信息,请参见如何获取实例ID

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称

类型

示例值

描述

Code String 200

200表示成功。其它表示错误码。错误码详情,请参见错误码

Data Struct

调用成功时,返回设备的轨迹信息。

DeviceName String mock_device_name

设备名称。

Points Array of Points

轨迹点列表,最多返回200个点。

LocateTime Long 1645071254000

位置点时间,如果是纠偏过的轨迹,则没有该字段。

Location String 120.0,30.0

轨迹点坐标,格式为:(经度,维度)。

ProductKey String g3r****Vjta

设备所属产品的productKey

ErrorMessage String request parameter error

调用失败时,返回的出错信息。

RequestId String 4C717018-B6D4-5EB0-8495-2A4FF08D58CA

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功。

  • true:表示调用成功。
  • false:表示调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GisSearchDeviceTrace&<公共请求参数>&ProductKey=g3r****Vjta&DeviceName=mock_device_name&StartTime=1645071254000&EndTime=1645071254000&IotInstanceId=iot-a****13l&MapMatch=0

正常返回示例

XML格式

<GisSearchDeviceTraceResponse>
      <RequestId>4C717018-B6D4-5EB0-8495-2A4FF08D58CA</RequestId>
      <Data>
            <ProductKey>g3r****Vjta</ProductKey>
            <DeviceName>mock_device_name</DeviceName>
            <Points>
                  <LocateTime>1645071254000</LocateTime>
                  <Location>120.0,30.0</Location>
            </Points>
      </Data>
      <Code>200</Code>
      <Success>true</Success>
</GisSearchDeviceTraceResponse>

JSON格式

{
    "GisSearchDeviceTraceResponse": {
        "RequestId": "4C717018-B6D4-5EB0-8495-2A4FF08D58CA",
        "Data": {
            "ProductKey": "g3r****Vjta",
            "DeviceName": "mock_device_name",
            "Points": [
                {
                    "LocateTime": 1645071254000,
                    "Location": "120.0,30.0"
                }
            ]
        },
        "Code": 200,
        "Success": true
    }
}