更新时间:2025-03-21 GMT+08:00

查询SMN主题

功能介绍

该接口用于查询SMN主题。

URI

GET /v2/{project_id}/lts/notifications/topics

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID

最小长度:32

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

查询游标,初始传入0,后续从上一次的返回值中获取。

最小值:0

最大值:1024

limit

Integer

每页数据量,最大值为100。

最小值:0

最大值:100

fuzzy_name

String

检索的主题名称,模糊匹配,按照startwith模式进行匹配。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token,获取方式请参见:获取用户Token

最小长度:1000

最大长度:2000

Content-Type

String

该字段填为:application/json;charset=UTF-8。

最小长度:30

最大长度:30

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识

topic_count

Integer

topics数量

topics

Array of Topics objects

主题信息

表5 Topics

参数

参数类型

描述

name

String

主题名称。

topic_urn

String

Topic的唯一的资源标识。

display_name

String

Topic的显示名,推送邮件消息时,作为邮件发件人显示。

push_policy

Integer

消息推送的策略。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误内容

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

报错内容

请求示例

查询SMN主题

GET https://{endpoint}/v2/{project_id}/lts/notifications/topics

/v2/{project_id}/lts/notifications/topics?offset={offset}&limit={limit} 

响应示例

状态码:200

请求响应成功。

{
  "request_id" : "1",
  "topic_count" : 100,
  "topics" : [ {
    "name" : "test",
    "topic_urn" : "urn:smn:xxxx-7:{projectId}:fyy",
    "display_name" : "username",
    "push_policy" : 0
  } ]
}

状态码:400

权限不足

{
  "error_code" : "LTS.2009",
  "error_msg" : "User must have SMN service authority."
}

状态码:500

请求成功但是服务异常。

{
  "error_code" : "LTS.0010",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

请求响应成功。

400

权限不足

500

请求成功但是服务异常。

错误码

请参见错误码