跳转到主要内容
ZStack
告警与响应相关接口/告警通道与集成

查询告警渠道列表

按保存的名称查询通知渠道。`search` 与重复的 `searchTerms` 去除首尾空白、忽略空项并去重后，以不区分大小写的字面子串按 `OR` 关系匹配。例如：`?search=Telegram&searchTerms=Ops&searchTerms=Backup`。结果与 `Accept-Language` 无关；显示名称映射由调用方提供。在总数统计和分页前应用筛选；先按 `createDate` 降序，再按 UUID 升序排列。

GET/api/v1/alerting/channels

操作 ID

ListAlertChannels

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • page
    Integer

    页码。默认值为 `1`。

    示例： 0

  • pageSize
    Integer

    每页返回的记录数。

    示例： 0

  • search
    String

    搜索关键字。

  • searchTerms
    List

    附加的名称字面量关键词，与 `search` 按 `OR` 关系匹配。使用重复的查询参数：`searchTerms=Ops&searchTerms=Backup`（不是逗号分隔的列表）。关键词会去除首尾空白、忽略空项并去重；全部为空时不执行搜索。使用标准 URL 编码：空格使用 + 或 %20，字面加号使用 %2B。

  • alarmType
    String

    告警类型。

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • items
    List

    条目列表。

    示例： (nested array)

    • uuid
      String

      资源的UUID，唯一标识该资源。

      示例： chan-001

    • name
      String

      资源名称。

      示例： Ops Email Channel

    • description
      String

      资源的详细描述。

      示例： Email notifications for operations team

    • type
      String

      类型。

      示例： email

    • status
      String

      状态信息。

      示例： active

    • config
      Object

      配置信息。

      示例： (nested object)

    • templateId
      String

      模板ID。

      示例： tmpl-email-001

    • alertCount
      String

      告警数量。

      示例： 150

    • createDate
      String

      创建时间。

      示例： 2026-01-15T08:00:00Z

    • lastOpDate
      String

      最近一次操作时间。

      示例： 2026-01-15T08:00:00Z

    • language
      String

      通知语言：`en-US` 或 `zh-CN`。

      示例： en-US

    • alarmType
      String

      告警类型。

      示例： event

  • total
    Integer

    返回结果总数。

    示例： 5

  • limit
    Integer

    最大返回条目数。

    示例： 20

  • offset
    Integer

    查询起始偏移量。

    示例： 20

变更历史

查看全部变更历史

  • 变更时间

    新增请求参数 alarmType新增响应字段 alarmType
    查看 API

  • 变更时间

    新增请求参数 search, searchTerms新增响应字段 language
    查看 API