文档首页/ 消息通知服务 SMN/ API参考/ API/ 主题操作/ 查询主题的发送详情
更新时间:2025-06-24 GMT+08:00
分享

查询主题的发送详情

功能介绍

查询Topic的发送数据详情,最多支持查询31天内所有计量数据

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/notifications/topics/{topic_urn}/statistics

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取项目ID请参考 获取项目ID

topic_urn

String

Topic的唯一的资源标识,可通过查询主题列表获取该标识。

表2 Query参数

参数

是否必选

参数类型

描述

start_time

String

起始时间

end_time

String

结束时间

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

total

SumCountDetail object

周期内的发送总量

statistics

Array of StatisticsDetail objects

周期内的发送详情列表

表5 SumCountDetail

参数

参数类型

描述

sms

Integer

短信发送总量

表6 StatisticsDetail

参数

参数类型

描述

count

CountDetail object

周期内的发送详情

start_time

String

起始时间

表7 CountDetail

参数

参数类型

描述

sms

Integer

短信发送数量

状态码:400

表8 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

error_code

String

返回信息对应的代码。

error_msg

String

服务异常错误信息描述。

状态码:403

表9 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

error_code

String

返回信息对应的代码。

error_msg

String

服务异常错误信息描述。

状态码:500

表10 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

error_code

String

返回信息对应的代码。

error_msg

String

服务异常错误信息描述。

请求示例

查询Topic的发送数据详情

GET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_topic/statistics?start_time="2025-02-17T16:00:00Z"&end_time='2025-02-19T15:59:59Z'

响应示例

状态码:200

OK

{
  "request_id" : "stringxxxxxxxxxxxxxxx",
  "total" : {
    "sms" : 123
  },
  "statistics" : [ {
    "count" : {
      "sms" : 123
    },
    "start_time" : "2025-02-17T16:00:00Z"
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Unauthorized

500

Internal Server Error

错误码

请参见错误码

相关文档