调用该接口统计符合过滤条件的通知数量。

调试

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

请求参数

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

系统规定参数。取值:CountNotifications

HandleState String UNHANDLED

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

BeginMillis Long 1514736000000

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

EndMillis Long 1514736000000

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

Category.N String GATEWAY_OFFLINE

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

  • GATEWAY_OFFLINE:网关离线信息。
  • JOIN_PERMISSION_AUTH_APPLYING:凭证授权中。
  • JOIN_PERMISSION_AUTH_ACCEPTED:凭证授权成功。
  • JOIN_PERMISSION_AUTH_CANCELED:撤销凭证授权。
  • JOIN_PERMISSION_AUTH_REJECTED:拒绝凭证授权。

返回数据

名称 类型 示例值 描述
Data Long 10

通知数量。

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

请求ID。

Success Boolean true

是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=CountNotifications
&<公共请求参数>

正常返回示例

XML格式

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

<CountNotificationsResponse>
      <Data>10</Data>
      <RequestId>89EF6CAA-958F-F32C-BE45-FE003C6DE097</RequestId>
      <Success>true</Success>
</CountNotificationsResponse>

JSON格式

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

{
  "Data" : 10,
  "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. 内部错误。

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