调用该接口查询设备位置信息。

QPS限制

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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GisQueryDeviceLocation

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

IotInstanceId String iot-a****13l

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

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

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

ThingList.N.ProductKey String g3r****Vjta

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

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

注意 每个设备的 ProductKeyDeviceName必须同时传入,且设备个数不能超过20个。
ThingList.N.DeviceName String mock_device_name

要查询的设备名列表。

注意 每个设备的 ProductKeyDeviceName必须同时传入,且设备个数不能超过20个。

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

返回数据

名称 类型 示例值 描述
Code String 200

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

Data Array of data

调用成功时,返回设备的位置信息。

Adcode Long 90000

高德adcode,adcode信息可参考城市编码表。

说明 城市编码表,更新于2020年7月27日,该表用于查询不同城市对应的编码。仅供查询使用,建议通过地址解析等线上服务实时获取最新编码。暂时不支持台湾省的行政区域编码查询。

下载链接

City String 杭州

设备所在城市。

CoordinateSystem Integer 1

坐标类型。

  • 1:WGS_84,国际经纬度坐标系统。
  • 2:GCJ_02,由国测局制定,是对地理位置进行首次加密后的一种坐标系统。
Country String 中国

设备所在国家。

DeviceName String mock_device_name

设备名称。

Ip String 127.0.0.1

设备上线的IP。

Latitude Float 30.0

设备位置的纬度。

Longitude Float 120.0

设备位置的经度。

ProductKey String g3r****Vjta

设备所属产品的productKey

Province String 浙江省

设备所在省。

ErrorMessage String request parameter error

调用失败时,返回的出错信息,如果调用成功,没有ErrorMessage字段。

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

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

Success Boolean true

是否调用成功。

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

示例

请求示例

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

正常返回示例

XML格式

<GisQueryDeviceLocationResponse>
      <RequestId>4C717018-B6D4-5EB0-8495-2A4FF08D58CA</RequestId>
      <Data>
            <CoordinateSystem>1</CoordinateSystem>
            <Ip>127.0.0.1</Ip>
            <Country>中国</Country>
            <Adcode>90000</Adcode>
            <Latitude>30</Latitude>
            <City>杭州</City>
            <Longitude>120</Longitude>
            <Province>浙江省</Province>
            <ProductKey>g3r****Vjta</ProductKey>
            <DeviceName>mock_device_name</DeviceName>
      </Data>
      <Code>200</Code>
      <Success>true</Success>
</GisQueryDeviceLocationResponse>

JSON格式

{
    "GisQueryDeviceLocationResponse": {
        "RequestId": "4C717018-B6D4-5EB0-8495-2A4FF08D58CA",
        "Data": {
            "CoordinateSystem": 1,
            "Ip": "127.0.0.1",
            "Country": "中国",
            "Adcode": 90000,
            "Latitude": 30.0,
            "City": "杭州",
            "Longitude": 120.0,
            "Province": "浙江省",
            "ProductKey": "g3r****Vjta",
            "DeviceName": "mock_device_name"
        },
        "Code": 200,
        "Success": true
    }
}