调用该接口查询当前用户账号下所有网关的地理位置信息。

调试

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

请求参数

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

系统规定参数。取值：ListGatewaysGisInfo。

IotInstanceId String 否 iot-***-v6***

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

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

实例的更多信息，请参见实例概述。

返回数据

名称 类型 示例值 描述
Success Boolean true

是否调用成功。

  • true：调用成功。
  • false：调用失败。
RequestId String 89EF6CAA-958F-F32C-BE45-FE003C6DE097

请求ID，阿里云为该请求生成的唯一标识符。
Data Array of GatewayGisInfo

网关位置信息列表。
ChargeStatus String NORMAL

网关欠费状态。

  • NORMAL：网关未欠费，正常工作。
  • ARREARAGE：网关欠费。
GisSourceType String HARDWARE

网关GIS来源，可取值：

  • USER_INPUT：用户输入。
  • HARDWARE：网关上报。
FreqBandPlanGroupId Long 102

网关采用的频段ID。
Enabled Boolean true

网关是否可用。
GisCoordinateSystem String GCJ_02

网关经纬度所采用的坐标系统，可取值为：WGS_84，GCJ_02。

Longitude Float 123.45678

网关经度。
Latitude Float 23.45678

网关纬度。
OnlineState String OFFLINE

网关的在线、离线状态。可取值：

  • ONLINE：在线。
  • OFFLINE：离线。
Name String 网关名称

自定义网关名称。
GwEui String 0000000000000000

网关唯一标识。
AuthTypes String STANDARD

网关合约类型。

  • HYBRID：Hybrid网关。
  • SINGLE_CHANNEL：单通道网关。
  • STANDARD：标准合约网关。

示例

请求示例

http(s)://linkwan.cn-shanghai.aliyuncs.com/?Action=ListGatewaysGisInfo
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListGatewaysGisInfoResponse>
    <Success>true</Success>
    <RequestId>89EF6CAA-958F-F32C-BE45-FE003C6DE097</RequestId>
    <Data>
        <ChargeStatus>NORMAL</ChargeStatus>
        <GisSourceType>HARDWARE</GisSourceType>
        <FreqBandPlanGroupId>102</FreqBandPlanGroupId>
        <Enabled>true</Enabled>
        <GisCoordinateSystem>GCJ_02</GisCoordinateSystem>
        <Longitude>123.45678</Longitude>
        <Latitude>23.45678</Latitude>
        <OnlineState>OFFLINE</OnlineState>
        <Name>网关名称</Name>
        <GwEui>0000000000000000</GwEui>
        <AuthTypes>STANDARD</AuthTypes>
    </Data>
</ListGatewaysGisInfoResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "RequestId" : "89EF6CAA-958F-F32C-BE45-FE003C6DE097",
  "Data" : [ {
    "ChargeStatus" : "NORMAL",
    "GisSourceType" : "HARDWARE",
    "FreqBandPlanGroupId" : 102,
    "Enabled" : true,
    "GisCoordinateSystem" : "GCJ_02",
    "Longitude" : 123.45678,
    "Latitude" : 23.45678,
    "OnlineState" : "OFFLINE",
    "Name" : "网关名称",
    "GwEui" : "0000000000000000",
    "AuthTypes" : "STANDARD"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 ForbiddenByRam User not authorized to operate on the specified resource, or this API does not support RAM. 用户没有执行该操作所需要的RAM权限。
400 ForbiddenByRiskControl This operation cannot be performed because of security risks. 存在安全风险，无法执行该操作
400 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误。

访问错误中心查看更多错误码。