调用该接口获取通知列表。

调试

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

请求参数

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

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

Category.N String 否 GATEWAY_OFFLINE

通知类型列表，传null则不过滤类型。

  • GATEWAY_OFFLINE：网关离线通知。
  • JOIN_PERMISSION_AUTH_APPLYING：入网凭证申请。
  • JOIN_PERMISSION_AUTH_ACCEPTED：入网凭证审批通过。
  • JOIN_PERMISSION_AUTH_CANCELED：入网凭证申请撤销。
  • JOIN_PERMISSION_AUTH_REJECTED：入网凭证申请拒绝。
  • GATEWAY_DATAFLOW_LIMIT：网关限流。
HandleState String 否 HANDLED

根据通知处理状态过滤，传null则不过滤处理状态。

  • HANDLED：已处理。
  • UNHANDLED：未处理。
Offset Long 是 0

查询的起始位置，需从0开始。
Limit Long 是 2

查询的通知数量上限，需大于等于1。
BeginMillis Long 否 1514736000000

开始时间查询，毫秒为单位的UNIX时间戳。
EndMillis Long 否 1514736000000

结束时间查询，毫秒为单位的UNIX时间戳。
SortingField String 否 NOTICE_MILLIS

排序字段，可取值为NOTICE_MILLIS（按照通知发生时间排序）。

Ascending Boolean 否 false

配合SortingField参数一起使用。

  • true：表示升序。
  • false：表示降序。

返回数据

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

是否调用成功。

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

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

返回的结果。
TotalCount Long 100

符合过滤条件的通知总数。
List Array of Notification

符合过滤条件的通知列表。
NoticeMillis Long 1514736000000

通知发生时间，UNIX时间戳，毫秒为单位。
Category String GATEWAY_OFFLINE

通知分类。
HandleState String HANDLED

通知处理状态。
NotificationId String 123

通知ID。
HandledMillis Long 1514736000001

通知处理时间，UNIX时间戳，毫秒为单位。
GatewayOfflineInfo Object

记录网关离线信息。

当Category字段为GATEWAY_OFFLINE时，该字段有值。

GwEui String 0000000000000000

网关的GwEUI。
OfflineMillis Long 1514736000000

离线时间，毫秒为单位的UNIX时间戳。
JoinPermissionAuthInfo Object

记录凭证授权信息。

当Category字段为JOINPERMISSION_AUTH时，该字段有值。

CanceledMillis Long 1514736000000

工单被取消的UNIX时间戳，毫秒为单位。
ApplyingMillis Long 1514736000000

发起工单的UNIX时间戳，毫秒为单位。
JoinEui String 0000000000000001

入网凭证所使用的JoinEUI。
RenterAliyunId String some-user

入网凭证租户的阿里云账号ID。
AcceptedMillis Long 1514736000000

工单审批通过的UNIX时间戳，毫秒为单位。
OwnerAliyunId String some-user1

发起授权的入网凭证拥有者的阿里云账号ID。
RejectedMillis Long 1514736000000

工单被拒绝的UNIX时间戳，毫秒为单位。
JoinPermissionId String 126

唯一标识入网凭证的ID。
JoinPermissionName String 凭证2

入网凭证的名称。
OrderState String ACCEPTED

工单状态。
OrderId String 123

工单ID。
GatewayDataflowLimit Object

网关限流通知。
AlarmDetail String GATEWAY_DATAFLOW_LIMIT

通知内容。
DataflowLimitMillis Long 1653450720919

限流时间。
GwEui String 0000000000000000

网关的唯一标识。

示例

请求示例

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

正常返回示例

XML格式 

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

<ListNotificationsResponse>
    <Success>true</Success>
    <RequestId>89EF6CAA-958F-F32C-BE45-FE003C6DE097</RequestId>
    <Data>
        <TotalCount>100</TotalCount>
        <List>
            <NoticeMillis>1514736000000</NoticeMillis>
            <Category>GATEWAY_OFFLINE</Category>
            <HandleState>HANDLED</HandleState>
            <NotificationId>123</NotificationId>
            <HandledMillis>1514736000001</HandledMillis>
            <GatewayOfflineInfo>
                <GwEui>0000000000000000</GwEui>
                <OfflineMillis>1514736000000</OfflineMillis>
            </GatewayOfflineInfo>
            <JoinPermissionAuthInfo>
                <CanceledMillis>1514736000000</CanceledMillis>
                <ApplyingMillis>1514736000000</ApplyingMillis>
                <JoinEui>0000000000000001</JoinEui>
                <RenterAliyunId>some-user</RenterAliyunId>
                <AcceptedMillis>1514736000000</AcceptedMillis>
                <OwnerAliyunId>some-user1</OwnerAliyunId>
                <RejectedMillis>1514736000000</RejectedMillis>
                <JoinPermissionId>126</JoinPermissionId>
                <JoinPermissionName>凭证2</JoinPermissionName>
                <OrderState>ACCEPTED</OrderState>
                <OrderId>123</OrderId>
            </JoinPermissionAuthInfo>
            <GatewayDataflowLimit>
                <AlarmDetail>GATEWAY_DATAFLOW_LIMIT</AlarmDetail>
                <DataflowLimitMillis>1653450720919</DataflowLimitMillis>
                <GwEui>0000000000000000</GwEui>
            </GatewayDataflowLimit>
        </List>
    </Data>
</ListNotificationsResponse>

JSON格式 

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

{
  "Success" : true,
  "RequestId" : "89EF6CAA-958F-F32C-BE45-FE003C6DE097",
  "Data" : {
    "TotalCount" : 100,
    "List" : [ {
      "NoticeMillis" : 1514736000000,
      "Category" : "GATEWAY_OFFLINE",
      "HandleState" : "HANDLED",
      "NotificationId" : "123",
      "HandledMillis" : 1514736000001,
      "GatewayOfflineInfo" : {
        "GwEui" : "0000000000000000",
        "OfflineMillis" : 1514736000000
      },
      "JoinPermissionAuthInfo" : {
        "CanceledMillis" : 1514736000000,
        "ApplyingMillis" : 1514736000000,
        "JoinEui" : "0000000000000001",
        "RenterAliyunId" : "some-user",
        "AcceptedMillis" : 1514736000000,
        "OwnerAliyunId" : "some-user1",
        "RejectedMillis" : 1514736000000,
        "JoinPermissionId" : "126",
        "JoinPermissionName" : "凭证2",
        "OrderState" : "ACCEPTED",
        "OrderId" : "123"
      },
      "GatewayDataflowLimit" : {
        "AlarmDetail" : "GATEWAY_DATAFLOW_LIMIT",
        "DataflowLimitMillis" : 1653450720919,
        "GwEui" : "0000000000000000"
      }
    } ]
  }
}

错误码

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