调用ListGateways API分页筛选获取网关信息列表-物联网络管理平台-阿里云

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListGateways	系统规定参数。取值：ListGateways。
IotInstanceId	String	否	iot-*-v6*	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。注意若有ID值，必须传入该ID值，否则调用会失败。若无ID值，则无需传入。实例的更多信息，请参见实例概述。
OnlineState	String	否	OFFLINE	网关的在线、离线状态过滤。如未传入此参数，则不限制在线状态。可取值为： ONLINE：在线。 OFFLINE：离线。
FuzzyGwEui	String	否	123456	GwEUI模糊过滤。
FuzzyCity	String	否	CityName	城市名模糊过滤。
FuzzyName	String	否	GatewayName	网关名称模糊过滤。
FreqBandPlanGroupId	Long	否	123	网关频段ID过滤。
IsEnabled	Boolean	否	true	网关的启用、停用状态过滤。如未传入此参数，则不限制启停状态。可取值为： true：启用。 false：停用。
Offset	Long	是	0	本次查询的起始位置，从0开始。
Limit	Long	是	2	本次查询的网关数量上限，最大支持200，须大于等于1。
SortingField	String	否	ONLINE_STATE_CHANGED_MILLIS	指定排序字段，可取值为ONLINE_STATE_CHANGED_MILLIS。
Ascending	Boolean	否	false	配合SortingField参数一起使用。 true：升序。 false：降序。

返回数据


名称	类型	示例值	描述
Success	Boolean	true	是否调用成功。 true：调用成功。 false：调用失败。
RequestId	String	89EF6CAA-958F-F32C-BE45-FE003C6DE097	请求ID，阿里云为该请求生成的唯一标识符。
Data	Object		返回的结果。
TotalCount	Long	2	满足过滤条件的网关总数。
List	Array of Gateway		查询到的网关信息列表。
ChargeStatus	String	NORMAL	网关欠费状态。 NORMAL：网关未欠费，正常工作。 ARREARAGE：网关欠费。
ClassBSupported	Boolean	true	该网关是否支持Class B模式。
FreqBandPlanGroupId	Long	123	网关频段ID。
District	String	某某区	网关所在城区名称。
GisCoordinateSystem	String	GCJ_02	网关经纬度所采用的坐标系统，可取值为WGS_84，GCJ_02。
City	String	某某市	网关所在城市名称。
TimeCorrectable	Boolean	true	该网关是否可以作为时间校准网关。
OnlineState	String	ONLINE	网关的在线、离线状态。可取值为： ONLINE：在线。 OFFLINE：离线。
AuthTypes	String	STANDARD	网关合约类型。 HYBRID：hybrid网关。 SINGLE_CHANNEL：单通道网关。 STANDARD：标准合约网关。
OnlineStateChangedMillis	Long	1514736000000	最近一次在线、离线状态的变更时间。格式为UNIX时间戳，以毫秒为单位。
CommunicationMode	String	HALF_DUPLEX	网关通信模式。可取值为： FULL_DUPLEX：全双工。 HALF_DUPLEX：半双工。
Description	String	网关描述	自定义网关描述。
Enabled	Boolean	true	该网关是否处于启用状态。 true：启用状态。 false：停用状态。
ClassBWorking	Boolean	true	该网关是否正工作在Class B模式下。 true：是。 false：否。
Address	String	详细地址	网关所在详细地址。
Longitude	Float	123.45678	网关经度。
EmbeddedNsId	String	123	Hybrid网关id。
Latitude	Float	23.45678	网关纬度。
Name	String	网关名称	自定义网关名称。
GwEui	String	0000000000000000	网关唯一标识。
AddressCode	Long	123	网关所在地区ID，由`http://lbs.amap.com/api/javascript-api/download`定义。

示例

请求示例

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

正常返回示例

XML格式

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

<ListGatewaysResponse>
      <Data>
            <TotalCount>23</TotalCount>
            <List>
                  <Gateway>
                        <City>某某市</City>
                        <Name>网关名称</Name>
                        <District>某某区</District>
                        <OnlineState>ONLINE</OnlineState>
                        <TimeCorrectable>true</TimeCorrectable>
                        <Enabled>true</Enabled>
                        <Longitude>123.45678</Longitude>
                        <Latitude>23.45678</Latitude>
                        <OnlineStateChangedMillis>1514736000000</OnlineStateChangedMillis>
                        <ClassBSupported>true</ClassBSupported>
                        <Address>详细地址</Address>
                        <GwEui>0000000000000000</GwEui>
                        <CommunicateMode>HALF_DUPLEX</CommunicateMode>
                        <ClassBWorking>true</ClassBWorking>
                        <FreqBandPlanGroupId>123</FreqBandPlanGroupId>
                        <AddressCode>123</AddressCode>
                        <GisCoordinateSystem>GCJ-02</GisCoordinateSystem>
                        <Description>网关描述</Description>
                  </Gateway>
                  <Gateway>
                        <City>某某市</City>
                        <Name>网关名称</Name>
                        <District>某某区</District>
                        <OnlineState>ONLINE</OnlineState>
                        <TimeCorrectable>true</TimeCorrectable>
                        <Enabled>true</Enabled>
                        <Longitude>123.45678</Longitude>
                        <Latitude>23.45678</Latitude>
                        <OnlineStateChangedMillis>1514736000000</OnlineStateChangedMillis>
                        <ClassBSupported>true</ClassBSupported>
                        <Address>详细地址</Address>
                        <GwEui>0000000000000000</GwEui>
                        <CommunicateMode>HALF_DUPLEX</CommunicateMode>
                        <ClassBWorking>true</ClassBWorking>
                        <FreqBandPlanGroupId>123</FreqBandPlanGroupId>
                        <AddressCode>123</AddressCode>
                        <GisCoordinateSystem>GCJ-02</GisCoordinateSystem>
                        <Description>网关描述</Description>
                  </Gateway>
            </List>
      </Data>
      <RequestId>89EF6CAA-958F-F32C-BE45-FE003C6DE097</RequestId>
      <Success>true</Success>
</ListGatewaysResponse>

JSON格式

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

{
  "Data" : {
    "TotalCount" : 23,
    "List" : [ {
      "TimeCorrectable" : true,
      "Enabled" : true,
      "Description" : "网关描述",
      "OnlineStateChangedMillis" : 1514736000000,
      "GisCoordinateSystem" : "GCJ-02",
      "AddressCode" : 123,
      "ClassBSupported" : true,
      "City" : "某某市",
      "Name" : "网关名称",
      "FreqBandPlanGroupId" : 123,
      "District" : "某某区",
      "ClassBWorking" : true,
      "Address" : "详细地址",
      "Latitude" : 23.45678,
      "Longitude" : 123.45678,
      "OnlineState" : "ONLINE",
      "CommunicateMode" : "HALF_DUPLEX",
      "GwEui" : "0000000000000000"
    }, {
      "TimeCorrectable" : true,
      "Enabled" : true,
      "Description" : "网关描述",
      "OnlineStateChangedMillis" : 1514736000000,
      "GisCoordinateSystem" : "GCJ-02",
      "AddressCode" : 123,
      "ClassBSupported" : true,
      "City" : "某某市",
      "Name" : "网关名称",
      "FreqBandPlanGroupId" : 123,
      "District" : "某某区",
      "ClassBWorking" : true,
      "Address" : "详细地址",
      "Latitude" : 23.45678,
      "Longitude" : 123.45678,
      "OnlineState" : "ONLINE",
      "CommunicateMode" : "HALF_DUPLEX",
      "GwEui" : "0000000000000000"
    } ]
  },
  "RequestId" : "89EF6CAA-958F-F32C-BE45-FE003C6DE097",
  "Success" : true
}

错误码


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.	内部错误。

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