> ## 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/*`。 * App Key 的接口授权范围（`api_scopes`）须允许本次操作；权限按 App Key 所属用户判断。 * 查看私有空间还要求您是账户所有者、Admin、空间创建者，或所属团队、管理团队的成员；公开空间仍需上述接口权限。 * `channel_id` 必填；`p` 默认 `1`，`limit` 默认 `100`，最多 `100`。 * `plugin_type` 和 `status` 各接受单个值。 * 返回完整 `integration_key`；`settings` 中已保存的密钥类值返回 `******`。集成 Key 用于告警接入，与管理接口的 App Key 不同。 ## OpenAPI ````yaml /api-reference/on-call.openapi.zh.json post /channel/integration/list openapi: 3.1.0 info: title: Flashduty 开放 API description: >- Flashduty 事件管理平台的公开 HTTP API —— 覆盖故障、通知模板、协作空间、值班排班、监控、RUM、以及平台管理。每次调用都需在 query 中携带 `app_key`，该 key 在 Flashduty 控制台 我的 → APP Key 中创建（也可放在请求头 `Fd-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: '' - name: On-call/标签增强 description: 自定义字段、富化规则及数据映射（映射规则、映射数据、映射 API）管理。 - name: On-call/分析看板 description: '' - name: On-call/状态页 description: '' - name: On-call/变更管理 description: '' - name: On-call/专属集成 description: 管理各协作空间的专属告警集成。 paths: /channel/integration/list: post: tags: - On-call/专属集成 summary: 查询专属集成列表 description: 查询指定协作空间的专属集成。 operationId: channel-integration-read-list requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ChannelIntegrationListRequest' example: channel_id: 20001 p: 1 limit: 20 responses: '200': description: 成功 content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/ChannelIntegrationListResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: p: 1 limit: 20 total: 1 items: - integration_id: 10001 channel_id: 20001 integration_key: 0123456789abcdef0123456789abcdef100 exclusive_data_source_id: 0 plugin_id: 9 plugin_type: standard.alert plugin_type_name: Standard alert category: event.alert name: Payments alerts description: Alerts for the payments channel status: enabled created_at: 1767225600 updated_at: 1767225600 last_time: 0 last_source_time: 0 settings: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: ChannelIntegrationListRequest: type: object description: 指定协作空间的专属集成查询条件。 required: - channel_id properties: channel_id: type: integer format: int64 minimum: 1 example: 20001 description: 要查询专属集成的协作空间 ID。 p: type: integer minimum: 1 default: 1 description: 页码，从 1 开始。 limit: type: integer minimum: 1 maximum: 100 default: 100 description: 每页条数，最多 100 条。 name: type: string maxLength: 49 description: 按集成名称过滤。 plugin_type: type: string description: 按单个集成类型过滤。 status: type: string enum: - enabled - disabled description: 按状态过滤：`enabled` 表示接收告警，`disabled` 表示暂停接入。 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: 接口返回的数据，格式见各接口的 200 响应。没有返回数据的接口会返回 `{}` 或完全不带 `data`。 required: - request_id ChannelIntegrationListResponse: type: object description: 一页专属集成结果。 required: - p - limit - total - items properties: p: type: integer description: 当前页码。 limit: type: integer description: 当前每页条数。 total: type: integer description: 符合条件的专属集成总数。 items: type: array items: $ref: '#/components/schemas/ChannelIntegrationItem' description: 当前页的专属集成。 ChannelIntegrationItem: type: object description: 协作空间专属集成，包含完整集成 Key 和脱敏配置。 required: - integration_id - channel_id - integration_key - exclusive_data_source_id - plugin_id - plugin_type - plugin_type_name - category - name - description - status - created_at - updated_at - last_time - last_source_time - settings properties: integration_id: type: integer format: int64 description: 专属集成 ID，后续接口调用使用此 ID。 channel_id: type: integer format: int64 description: 专属集成所属的协作空间 ID。 integration_key: type: string description: 用于告警接入的完整集成 Key，与管理接口的 App Key 不同。 exclusive_data_source_id: type: integer format: int64 description: 早期集成的兼容标识，无关联值时为 `0`；本组接口统一使用 `integration_id`。 plugin_id: type: integer format: int64 description: 集成类型的数字 ID；创建时使用字符串 `plugin_type`。 plugin_type: type: string description: 集成类型标识，例如 `standard.alert`。 plugin_type_name: type: string description: 按请求语言返回的集成类型显示名称。 category: type: string description: 集成分类；专属集成创建接口接受 `event.alert` 告警集成。 name: type: string description: 集成名称。 description: type: string description: 集成描述；未设置时为空字符串。 status: type: string enum: - enabled - disabled description: 集成状态：`enabled` 表示接收告警，`disabled` 表示暂停接入。 created_at: type: integer format: int64 description: 创建时间，Unix 时间戳，单位为秒。 updated_at: type: integer format: int64 description: 最近更新时间，Unix 时间戳，单位为秒。 last_time: type: integer format: int64 description: 最近接收事件的时间，Unix 时间戳，单位为秒；未接收事件时为 `0`。 last_source_time: type: integer format: int64 description: 最近事件的来源时间，Unix 时间戳，单位为秒；无可用值时为 `0`。 settings: type: object additionalProperties: true description: 集成类型对应的配置；响应中已保存的密钥类值以 `******` 返回。 ErrorResponse: type: object description: 错误响应结构。`error` 必填，`data` 不存在。 properties: request_id: type: string example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 description: 本次请求的唯一追踪 ID（trace ID），反馈问题时请提供该值以便检索日志。 error: $ref: '#/components/schemas/DutyError' required: - request_id - error DutyError: type: object description: 响应结构中的错误 payload，仅在非 2xx 响应时出现。 properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string description: >- 按响应语言（query 参数 `locale` / `lang` 或请求头 `Accept-Language`）返回的错误描述，可能包含出错的字段名，请不要解析它。 example: The specified parameter template_id is not valid. required: - code - message ErrorCode: type: string description: >- 错误码。所有失败响应都会把 `error.code` 设为下列稳定字符串之一，请以它而不是 HTTP 状态码做判断。 | 错误码 | HTTP | 含义 | |---|---|---| | `OK` | 200 | 保留值，失败的请求不会返回。 | | `InvalidParameter` | 400 | 参数缺失、类型错误或未通过校验，`message` 通常会指出字段名。 | | `BadRequest` | 400 | 请求违反业务规则或与对象当前状态冲突，`message` 会说明原因。 | | `InvalidContentType` | 400 | 请求体没有以 `application/json` 发送。 | | `ResourceNotFound` | 400 | 引用的对象在本账户中不存在或已删除。注意 HTTP 状态码是 400 而不是 404。 | | `NoLicense` | 400 | 账户套餐不包含该功能、套餐配额已用完、套餐已过期或额度不足。 | | `ReferenceExist` | 400 | 对象仍被其他对象引用，无法删除。 | | `Unauthorized` | 401 | APP Key 缺失、无效或已删除。 | | `BalanceNotEnough` | 402 | 仅用于控制台计费流程，Open API 接口不会返回。 | | `AccessDenied` | 403 | APP Key 的权限范围或创建者角色不允许该操作或该对象。 | | `RouteNotFound` | 404 | 没有与该 HTTP 方法和路径匹配的接口。 | | `MethodNotAllowed` | 405 | 路径存在，但不支持该 HTTP 方法。 | | `UndonedOrderExist` | 409 | 仅用于控制台计费流程，Open API 接口不会返回。 | | `EntityTooLarge` | 413 | 请求体超出大小限制。 | | `RequestLocked` | 423 | 仅用于控制台登录保护，Open API 接口不会返回。 | | `RequestVerifyRequired` | 428 | 仅用于控制台验证码流程，Open API 接口不会返回。 | | `DangerousOperation` | 428 | 仅用于控制台高风险操作的 MFA 校验，Open API 接口不会返回。 | | `RequestTooFrequently` | 429 | 触发频率限制；请等待响应头 `Flashcat-Request-Rate-Limit-Delay` 给出的秒数后再重试。 | | `InternalError` | 500 | 服务端意外错误；请退避后重试，反馈问题时附上 `request_id`。 | | `ServiceUnavailable` | 503 | 后端依赖过载或不可用，请退避后重试。 | enum: - OK - InvalidParameter - BadRequest - InvalidContentType - ResourceNotFound - NoLicense - ReferenceExist - Unauthorized - BalanceNotEnough - AccessDenied - RouteNotFound - MethodNotAllowed - UndonedOrderExist - EntityTooLarge - RequestLocked - RequestVerifyRequired - DangerousOperation - RequestTooFrequently - InternalError - ServiceUnavailable x-enumDescriptions: OK: 保留值，失败的请求不会返回。 InvalidParameter: 参数缺失、类型错误或未通过校验，`message` 通常会指出字段名。 BadRequest: 请求违反业务规则或与对象当前状态冲突，`message` 会说明原因。 InvalidContentType: 请求体没有以 `application/json` 发送。 ResourceNotFound: 引用的对象在本账户中不存在或已删除。注意 HTTP 状态码是 400 而不是 404。 NoLicense: 账户套餐不包含该功能、套餐配额已用完、套餐已过期或额度不足。 ReferenceExist: 对象仍被其他对象引用，无法删除。 Unauthorized: APP Key 缺失、无效或已删除。 BalanceNotEnough: 仅用于控制台计费流程，Open API 接口不会返回。 AccessDenied: APP Key 的权限范围或创建者角色不允许该操作或该对象。 RouteNotFound: 没有与该 HTTP 方法和路径匹配的接口。 MethodNotAllowed: 路径存在，但不支持该 HTTP 方法。 UndonedOrderExist: 仅用于控制台计费流程，Open API 接口不会返回。 EntityTooLarge: 请求体超出大小限制。 RequestLocked: 仅用于控制台登录保护，Open API 接口不会返回。 RequestVerifyRequired: 仅用于控制台验证码流程，Open API 接口不会返回。 DangerousOperation: 仅用于控制台高风险操作的 MFA 校验，Open API 接口不会返回。 RequestTooFrequently: 触发频率限制；请等待响应头 `Flashcat-Request-Rate-Limit-Delay` 给出的秒数后再重试。 InternalError: 服务端意外错误；请退避后重试，反馈问题时附上 `request_id`。 ServiceUnavailable: 后端依赖过载或不可用，请退避后重试。 example: InvalidParameter 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. Forbidden: description: app_key 有效，但其权限范围或创建者角色不允许该操作或该对象。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: noEditPermission: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: AccessDenied message: Access Denied. TooManyRequests: description: 触发频率限制。请等待响应头 `Flashcat-Request-Rate-Limit-Delay` 给出的秒数后重试。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimited: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: RequestTooFrequently message: Request too frequently. headers: Flashcat-Request-Rate-Limit-Delay: description: 距当前限流窗口重置的秒数。请求被网关全局保护限流拒绝时不返回该响应头。 schema: type: integer minimum: 0 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。可通过 query 参数 `app_key` 或请求头 `Fd-App-Key` 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集，请妥善保管。 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.