> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flashduty.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 批量查询告警处理规则

> 返回多个集成的告警处理规则配置。

## 限制说明

| 项目   | 说明                             |
| ---- | ------------------------------ |
| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |
| 权限要求 | **集成中心查看**（`on-call`）          |

## 使用说明

* 所有 `integration_ids` 必须对调用方可访问。


## OpenAPI

````yaml /api-reference/on-call.openapi.zh.json post /alert/pipeline/list
openapi: 3.1.0
info:
  title: Flashduty 开放 API
  description: >-
    Flashduty 事件管理平台的公开 HTTP API —— 覆盖故障、通知模板、协作空间、值班排班、监控、RUM、以及平台管理。每次调用都需在
    query 中携带 `app_key`，该 key 在 Flashduty 控制台 账户 → APP Key 中签发。所有响应使用统一结构：成功时为
    `{ request_id, data }`，失败时为 `{ request_id, error }`。
  version: 1.0.0
servers:
  - url: https://api.flashcat.cloud
    description: Flashduty Open API
security:
  - AppKeyAuth: []
tags:
  - name: On-call/故障管理
    description: ''
  - name: On-call/协作空间
    description: ''
  - name: On-call/告警管理
    description: 查询、查看和处理告警，管理卡片视图与告警处理规则。
  - name: On-call/集成中心
    description: ''
  - name: On-call/IM 集成
    description: IM 集成相关查询，例如查看哪些集成开启了作战室。
  - name: On-call/值班排班
    description: ''
  - name: On-call/日历管理
    description: ''
  - name: On-call/通知模板
    description: ''
  - name: On-call/标签增强
    description: 自定义字段、富化规则及数据映射（映射规则、映射数据、映射 API）管理。
  - name: On-call/分析看板
    description: ''
  - name: On-call/状态页
    description: ''
  - name: On-call/变更管理
    description: ''
paths:
  /alert/pipeline/list:
    post:
      tags:
        - On-call/告警管理
      summary: 批量查询告警处理规则
      description: 返回多个集成的告警处理规则配置。
      operationId: alert-read-pipeline-list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertPipelineListRequest'
            example:
              integration_ids:
                - 10001
                - 10002
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/AlertPipelineListResponse'
              example:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                data:
                  items:
                    - integration_id: 10001
                      rules: []
                      status: enabled
                      creator_id: 80011
                      updated_by: 80011
                      created_at: 1710000000
                      updated_at: 1712000000
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    AlertPipelineListRequest:
      type: object
      required:
        - integration_ids
      properties:
        integration_ids:
          type: array
          items:
            type: integer
            format: int64
          description: 集成 ID 列表。
    SuccessEnvelope:
      type: object
      description: >-
        成功响应结构。2xx 响应中 `request_id` 标识本次调用（同时出现在 `Flashcat-Request-Id`
        响应头中），`data` 为接口业务 payload。失败响应使用不同结构，参见 `ErrorResponse`。
      properties:
        request_id:
          type: string
          description: 本次请求的唯一 ID，也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
        data:
          description: 每个接口自己的业务 payload，详见各接口的 200 响应 schema。
      required:
        - request_id
        - data
    AlertPipelineListResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AlertPipelineItem'
    AlertPipelineItem:
      type: object
      description: 集成的告警处理规则配置。
      properties:
        integration_id:
          type: integer
          format: int64
          description: 该处理规则所属的集成 ID。
        rules:
          type: array
          items:
            $ref: '#/components/schemas/AlertPipeline'
          description: 有序的处理规则列表。
        status:
          type: string
          description: 规则状态（如 `active`）。
        creator_id:
          type: integer
          format: int64
          description: 创建规则的成员 ID。
        updated_by:
          type: integer
          format: int64
          description: 最后更新规则的成员 ID。
        created_at:
          type: integer
          format: int64
          description: 创建时间，Unix 时间戳（秒）。
        updated_at:
          type: integer
          format: int64
          description: 最后更新时间，Unix 时间戳（秒）。
    ErrorResponse:
      type: object
      description: 错误响应结构。`error` 必填，`data` 不存在。
      properties:
        request_id:
          type: string
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
        error:
          $ref: '#/components/schemas/DutyError'
      required:
        - request_id
        - error
    AlertPipeline:
      type: object
      description: 单条告警处理规则。
      properties:
        kind:
          type: string
          enum:
            - title_reset
            - description_reset
            - severity_reset
            - alert_drop
            - alert_inhibit
          description: 规则类型。
        if:
          $ref: '#/components/schemas/OrFilterGroup'
          description: 可选的过滤条件，省略时对所有告警生效。
        settings:
          type: object
          description: >-
            与 `kind` 对应的配置。取值结构因 `kind` 而异：

            - `title_reset`：`{ "title": "<模板字符串>" }`

            - `description_reset`：`{ "description": "<模板字符串>" }`

            - `severity_reset`：`{ "severity": "Critical"|"Warning"|"Info" }`

            - `alert_drop`：`{}` (空对象)

            - `alert_inhibit`：`{ "equals": ["<标签键>", ...], "source_filters":
            <OrFilterGroup> }`
          oneOf:
            - $ref: '#/components/schemas/ApTitleReset'
            - $ref: '#/components/schemas/ApDescriptionReset'
            - $ref: '#/components/schemas/ApSeverityReset'
            - $ref: '#/components/schemas/ApAlertDrop'
            - $ref: '#/components/schemas/ApAlertInhibit'
    DutyError:
      type: object
      description: 响应结构中的错误 payload，仅在非 2xx 响应时出现。
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          description: 用户可读的错误描述，语言会跟随调用方的 Accept-Language。可能包含字段名、ID 等请求上下文。
          example: The specified parameter template_id is not valid.
      required:
        - code
        - message
    OrFilterGroup:
      type: array
      description: OR-of-AND 过滤树。外层数组为 AND 组列表，任意一个 AND 组匹配即通过；AND 组内所有条件须同时满足。
      items:
        type: array
        description: AND 组——组内所有条件须同时满足。
        items:
          $ref: '#/components/schemas/FilterCondition'
    ApTitleReset:
      type: object
      description: '`title_reset` 规则的配置：使用模板字符串覆盖告警标题。'
      required:
        - title
      properties:
        title:
          type: string
          description: 新标题模板，支持引用告警字段的 Golang 模板语法。
    ApDescriptionReset:
      type: object
      description: '`description_reset` 规则的配置：使用模板字符串覆盖告警描述。'
      required:
        - description
      properties:
        description:
          type: string
          description: 新描述模板。
    ApSeverityReset:
      type: object
      description: '`severity_reset` 规则的配置：将告警严重程度强制设置为固定值。'
      required:
        - severity
      properties:
        severity:
          type: string
          enum:
            - Critical
            - Warning
            - Info
          description: 目标严重程度级别。
    ApAlertDrop:
      type: object
      description: '`alert_drop` 规则的配置：无需额外配置，匹配的告警将被静默丢弃。'
      properties: {}
    ApAlertInhibit:
      type: object
      description: '`alert_inhibit` 规则的配置：当来源告警与当前告警共享相同标签值时，抑制匹配过滤条件的来源告警。'
      required:
        - equals
        - source_filters
      properties:
        equals:
          type: array
          items:
            type: string
          description: 需要在来源告警与当前告警之间值相等的标签键列表。
        source_filters:
          $ref: '#/components/schemas/OrFilterGroup'
          description: 用于匹配待抑制来源告警的过滤条件。
    ErrorCode:
      type: string
      description: >-
        Flashduty 错误码枚举。每个失败响应的 `error.code` 都是下列稳定值之一，HTTP 状态码仅作参考。


        | 错误码 | HTTP | 含义 |

        |---|---|---|

        | `OK` | 200 | 保留值，正常错误响应不会返回。 |

        | `InvalidParameter` | 400 | 必填参数缺失或未通过校验。 |

        | `BadRequest` | 400 | 通用的 400 错误，通常是请求本身不合法。 |

        | `InvalidContentType` | 400 | 请求头 `Content-Type` 不是 `application/json`。
        |

        | `ResourceNotFound` | 400 | 目标资源不存在。注意 HTTP 状态码是 400 而非 404（历史设计）。 |

        | `NoLicense` | 400 | 功能需要有效授权，但未找到可用的 license。 |

        | `ReferenceExist` | 400 | 该资源仍被其他实体引用，无法删除。 |

        | `Unauthorized` | 401 | `app_key` 缺失、无效或已过期。 |

        | `BalanceNotEnough` | 402 | 账户余额不足，无法执行需要计费的操作。 |

        | `AccessDenied` | 403 | 身份认证通过，但 RBAC 权限不足以执行该操作。 |

        | `RouteNotFound` | 404 | 请求的 URL 路径不是已知路由。 |

        | `MethodNotAllowed` | 405 | 当前路径不接受所使用的 HTTP 方法。 |

        | `UndonedOrderExist` | 409 | 账户存在未完成的订单，请稍后重试。 |

        | `RequestLocked` | 423 | 因连续失败被临时锁定。 |

        | `EntityTooLarge` | 413 | 请求体超过允许的最大长度。 |

        | `RequestTooFrequently` | 429 | 命中限流（全局、账户级或集成级）。 |

        | `RequestVerifyRequired` | 428 | 操作需要二次验证码，但未提供。 |

        | `DangerousOperation` | 428 | 危险操作，需要进行 MFA 验证。 |

        | `InternalError` | 500 | 服务端未预期错误。反馈问题请附上 `request_id`。 |

        | `ServiceUnavailable` | 503 | 后端依赖不可用，请稍后重试。 |
      enum:
        - OK
        - InvalidParameter
        - BadRequest
        - InvalidContentType
        - ResourceNotFound
        - NoLicense
        - ReferenceExist
        - Unauthorized
        - BalanceNotEnough
        - AccessDenied
        - RouteNotFound
        - MethodNotAllowed
        - UndonedOrderExist
        - RequestLocked
        - EntityTooLarge
        - RequestTooFrequently
        - RequestVerifyRequired
        - DangerousOperation
        - InternalError
        - ServiceUnavailable
      x-enumDescriptions:
        OK: 保留值，正常错误响应不会返回。
        InvalidParameter: 必填参数缺失或未通过校验。
        BadRequest: 通用的 400 错误，通常是请求本身不合法。
        InvalidContentType: 请求头 `Content-Type` 不是 `application/json`。
        ResourceNotFound: 目标资源不存在。注意 HTTP 状态码是 400 而非 404（历史设计）。
        NoLicense: 功能需要有效授权，但未找到可用的 license。
        ReferenceExist: 该资源仍被其他实体引用，无法删除。
        Unauthorized: '`app_key` 缺失、无效或已过期。'
        BalanceNotEnough: 账户余额不足，无法执行需要计费的操作。
        AccessDenied: 身份认证通过，但 RBAC 权限不足以执行该操作。
        RouteNotFound: 请求的 URL 路径不是已知路由。
        MethodNotAllowed: 当前路径不接受所使用的 HTTP 方法。
        UndonedOrderExist: 账户存在未完成的订单，请稍后重试。
        RequestLocked: 因连续失败被临时锁定。
        EntityTooLarge: 请求体超过允许的最大长度。
        RequestTooFrequently: 命中限流（全局、账户级或集成级）。
        RequestVerifyRequired: 操作需要二次验证码，但未提供。
        DangerousOperation: 危险操作，需要进行 MFA 验证。
        InternalError: 服务端未预期错误。反馈问题请附上 `request_id`。
        ServiceUnavailable: 后端依赖不可用，请稍后重试。
      example: InvalidParameter
    FilterCondition:
      type: object
      required:
        - key
        - oper
        - vals
      properties:
        key:
          type: string
          description: >-
            过滤字段名。内置告警字段使用字段名（如
            `alert_severity`、`alert_key`、`check`、`resource`、`service`、`cluster`），自定义标签使用
            `labels.<name>` 前缀（如 `labels.env`、`labels.region`）。
        oper:
          type: string
          enum:
            - IN
            - NOTIN
          description: >-
            过滤操作符。`IN`：值必须匹配 `vals` 中的某一项；`NOTIN`：值不能匹配 `vals` 中任何一项。支持
            `/pattern/` 格式的正则表达式。
        vals:
          type: array
          items:
            type: string
          description: 匹配值列表。每一项为普通字符串或 `/regex/` 正则模式。
  responses:
    BadRequest:
      description: 请求非法 — 通常是参数缺失或格式不正确。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingParameter:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: InvalidParameter
                  message: The specified parameter is not valid.
    Unauthorized:
      description: app_key 缺失或无效。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingAppKey:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: Unauthorized
                  message: You are unauthorized.
    TooManyRequests:
      description: 命中限流。可能是全局 API 限流、账户级限流或集成级限流。限流按账户聚合。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rateLimited:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: RequestTooFrequently
                  message: Request too frequently.
    ServerError:
      description: 服务端未预期错误。反馈问题时请携带 request_id。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internal:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: InternalError
                  message: >-
                    We encountered an internal error, and it has been reported.
                    Please try again later.
  securitySchemes:
    AppKeyAuth:
      type: apiKey
      in: query
      name: app_key
      description: >-
        在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API
        时都必须携带。它等同于所属账户的身份凭证，请妥善保管。

````