调用该接口获取网关上下行数据包的统计信息。

调试

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

请求参数

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

系统规定参数。取值:ListGatewayTransferPackets

IotInstanceId String iotx-oxssh****

物联网平台的实例id,为空表示公共实例。

GwEui String 0000000000000000

要查询的网关的GwEUI。

DevEui String 0000000000000001

根据DevEUI过滤数据包。

Category String DOWNLINK_PACKET

数据包分类。

  • DOWNLINK_PACKET:下行包。
  • UPLINK_PACKET:上行包。
  • INVALID_PACKET:无效包。
PageNumber Integer 1

分页页码,从1开始。

PageSize Integer 2

分页大小,大于等于1。

BeginMillis Long 1514736000000

查询开始时间,毫秒为单位的UNIX时间戳。

EndMillis Long 1514736000000

查询结束时间,毫秒为单位的UNIX时间戳。

SortingField String LOG_MILLIS

排序字段,取值:LOG_MILLIS,表示按照时间排序。

Ascending Boolean true

配合SortingField参数一起使用,true表示升序,false表示降序。

返回数据

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

是否成功。

RequestId String 89EF6CAA-958F-F32C-BE45-FE003C6DE097

请求ID。

Data Object

返回的结果。

TotalCount Long 10

满足过滤条件的数据包总数。

List Array of Packet

满足过滤条件的数据包信息列表。

LogMillis String 1514736000000

数据包传输的UNIX时间戳,以毫秒为单位。

ProcessEvent String SUCCESS

该报文的处理结果。

Base64EncodedMacPayload String xxx

Base64编码后的MACPayload报文。

FPort Integer 99

收发此数据包时所使用的FPort。

Lsnr Float -10.5

收发此数据包的信噪比。

HasData Boolean true

此数据包中是否包含业务数据。

ClassMode String C

收发此数据包时的通信模式。

MacPayloadSize Long 15

此数据包的MACPayload报文长度。

MessageType String JOIN_REQUEST

消息类型。

Datr String SF12BW125

收发此数据包的数据速率。

DevAddr String 00000000

收发此数据包的节点的网络地址。

DevEui String 0000000000000001

收发此数据包的节点的DevEUI。

NodeOwnerAliyunId String 23546

节点拥有者的阿里云账号ID。

GwEui String 0000000000000000

收发此数据包所经过的网关的GwEUI。

Rssi Integer -110

收发此数据包的RSSI。

HasMacCommand Boolean true

此数据包中是否包含MAC指令。

Freq String 470.3

收发此数据包的频点。

MacCommandCIDs Array of Object ["0x01","0x02"]

这个数据包所携带的MAC指令列表。

示例

请求示例

http(s)://linkwan.cn-shanghai.aliyuncs.com/?Action=ListGatewayTransferPackets
&BeginMillis=1514736000000
&Category=DOWNLINK_PACKET
&EndMillis=1514736000000
&GwEui=0000000000000000
&PageNumber=1
&PageSize=2
&SortingField=LOG_MILLIS
&<公共请求参数>

正常返回示例

XML格式

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

<ListGatewayTransferPacketsResponse>
      <Data>
            <TotalCount>10</TotalCount>
            <List>
                  <GatewayTransferPacket>
                        <ClassMode>C</ClassMode>
                        <HasMacCommand>false</HasMacCommand>
                        <DevAddr>00000000</DevAddr>
                        <MacPayloadSize>12</MacPayloadSize>
                        <FPort>99</FPort>
                        <HasData>true</HasData>
                        <LogMillis>1514736000000</LogMillis>
                        <Datr>SF12BW125</Datr>
                        <NodeOwnerAliyunId>xxx</NodeOwnerAliyunId>
                        <ProcessEvent>DEVADDR_ILLEGAL</ProcessEvent>
                        <DevEui>0000000000000001</DevEui>
                        <Lsnr>-10.5</Lsnr>
                        <GwEui>0000000000000000</GwEui>
                        <Rssi>-110</Rssi>
                        <Freq>470.3</Freq>
                        <Base64EncodedMacPayload>xxxx</Base64EncodedMacPayload>
                  </GatewayTransferPacket>
                  <GatewayTransferPacket>
                        <ClassMode>C</ClassMode>
                        <HasMacCommand>false</HasMacCommand>
                        <DevAddr>00000000</DevAddr>
                        <MacPayloadSize>12</MacPayloadSize>
                        <FPort>99</FPort>
                        <HasData>true</HasData>
                        <LogMillis>1514736000000</LogMillis>
                        <Datr>SF12BW125</Datr>
                        <NodeOwnerAliyunId>xxx</NodeOwnerAliyunId>
                        <ProcessEvent>DEVADDR_ILLEGAL</ProcessEvent>
                        <DevEui>0000000000000001</DevEui>
                        <Lsnr>-10.5</Lsnr>
                        <GwEui>0000000000000000</GwEui>
                        <Rssi>-110</Rssi>
                        <Freq>470.3</Freq>
                        <Base64EncodedMacPayload>xxxx</Base64EncodedMacPayload>
                  </GatewayTransferPacket>
            </List>
      </Data>
      <RequestId>89EF6CAA-958F-F32C-BE45-FE003C6DE097</RequestId>
      <Success>true</Success>
</ListGatewayTransferPacketsResponse>

JSON格式

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

{
  "Data" : {
    "TotalCount" : 10,
    "List" : [ {
      "Datr" : "SF12BW125",
      "Base64EncodedMacPayload" : "xxxx",
      "Lsnr" : -10.5,
      "ClassMode" : "C",
      "Rssi" : -110,
      "FPort" : 99,
      "MacPayloadSize" : 12,
      "DevEui" : "0000000000000001",
      "HasData" : true,
      "NodeOwnerAliyunId" : "xxx",
      "ProcessEvent" : "DEVADDR_ILLEGAL",
      "DevAddr" : "00000000",
      "LogMillis" : 1514736000000,
      "Freq" : 470.3,
      "HasMacCommand" : false,
      "GwEui" : "0000000000000000"
    }, {
      "Datr" : "SF12BW125",
      "Base64EncodedMacPayload" : "xxxx",
      "Lsnr" : -10.5,
      "ClassMode" : "C",
      "Rssi" : -110,
      "FPort" : 99,
      "MacPayloadSize" : 12,
      "DevEui" : "0000000000000001",
      "HasData" : true,
      "NodeOwnerAliyunId" : "xxx",
      "ProcessEvent" : "DEVADDR_ILLEGAL",
      "DevAddr" : "00000000",
      "LogMillis" : 1514736000000,
      "Freq" : 470.3,
      "HasMacCommand" : false,
      "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 NonExistent The specified resource does not exist. 要操作的资源不存在。
400 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误。
400 NotResourceOwner You are not authorized to use this resource. 无权访问此资源

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