> ## Documentation Index > Fetch the complete documentation index at: https://docs.dify.ai/llms.txt > Use this file to discover all available pages before exploring further. # 取消数据源运行 > 取消尚未结束的数据源运行，并返回该运行。 被取消的运行会在更新数据源的页面列表之前停止。运行已处理完的条目会保留到下一次同步，下一次同步会移除不在页面列表中的条目。导入时未包含的条目，其文档不会被删除，除非取消恰好发生在这些文档正被移除时。 已以 `completed`、`zero_results` 或 `canceled` 结束的运行，原样返回。 如何跟踪、重试和取消运行，详见 [跟踪数据源运行](/zh/api-reference/guides/knowledge-base#follow-source-runs)。 ## OpenAPI ````yaml /zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/cancel openapi: 3.0.1 info: description: 用于 Dify 应用与知识库的 REST API。应用类接口使用应用 API 密钥认证，知识库类接口使用知识库 API 密钥认证。 title: Dify 服务 API version: 1.0.0 servers: - description: Dify 服务 API 的基础 URL。自部署时，替换为你的 API 基础 URL。 url: https://{api_base_url} variables: api_base_url: default: api.dify.ai/v1 description: API 基础 URL 的主机与路径，不含 `https://` 前缀。 security: - ApiKeyAuth: [] tags: - description: 与聊天消息和交互相关的操作。 name: 对话消息 - description: 文件上传和预览操作。 name: 文件操作 - description: 终端用户信息相关操作。 name: 终端用户 - description: 用户反馈操作。 name: 消息反馈 - description: 与管理会话相关的操作。 name: 会话管理 - description: 文字转语音和语音转文字操作。 name: 语音与文字转换 - description: 获取应用设置和信息的操作。 name: 应用配置 - description: 与管理标注直接回复相关的操作。 name: 标注管理 - description: 暂停等待人工输入的工作流恢复操作。 name: 人工介入 - description: 用于执行和管理工作流的操作。 name: 工作流运行 - description: 文本生成相关操作。 name: 文本生成消息 - description: 用于管理知识库的操作，包括创建、配置和检索。 name: 知识库 - description: 用于在知识库中创建、更新和管理文档的操作。 name: 文档 - description: 用于管理分段和子分段的操作。 name: 分段 - description: 用于管理知识库元数据字段和文档元数据值的操作。 name: 元数据 - description: 用于管理知识库标签和标签绑定的操作。 name: 标签 - description: 用于获取可用模型的操作。 name: 模型 - description: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。 name: 知识流水线 - description: 向知识库提问，并流式返回回答。 name: 查询 - description: 查看一次查询检索到了什么，以及原因。 name: 查询记录 - description: 在后台运行研究问题，并获取其结果。 name: 研究任务 - description: 读取知识库中的文档及其文件、修订版本和分段，并用元数据标注文档。 name: 文档与分段 - description: 跟踪、取消或重试索引，并列出知识库的后台任务。 name: 索引任务 - description: 跟踪文档文件、一批文件或数据源的删除，直到完成。 name: 删除作业 - description: 管理为知识库提供内容的数据源，以及它们的定时同步设置和连接。 name: 数据源 - description: 立即同步数据源，导入网站页面或提供商条目，并跟踪、取消或重试运行。 name: 数据源同步与导入 - description: 读取和更改知识库的模型与检索设置，并跟踪更改触发的迁移。 name: 设置 paths: /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/cancel: post: tags: - Source Syncs and Imports summary: 取消数据源运行 description: >- 取消尚未结束的数据源运行，并返回该运行。 被取消的运行会在更新数据源的页面列表之前停止。运行已处理完的条目会保留到下一次同步，下一次同步会移除不在页面列表中的条目。导入时未包含的条目，其文档不会被删除，除非取消恰好发生在这些文档正被移除时。 已以 `completed`、`zero_results` 或 `canceled` 结束的运行，原样返回。 如何跟踪、重试和取消运行，详见 [跟踪数据源运行](/zh/api-reference/guides/knowledge-base#follow-source-runs)。 operationId: cancelSourceRun parameters: - description: >- 知识库 ID：即知识库 **API 访问** 对话框中所示服务 API 端点的最后一段（`…/knowledge-fs/spaces/`），也是地址栏中 `/datasets/new/` 之后的那一段。 in: path name: knowledge_base_id required: true schema: format: uuid type: string - description: >- 运行 ID：取自启动该运行的响应或 [获取数据源运行列表](/zh/api-reference/source-syncs-and-imports/list-source-runs) 中的 `id`。 in: path name: run_id required: true schema: format: uuid type: string requestBody: content: application/json: examples: request: summary: 请求示例 value: reason: Preview not needed schema: additionalProperties: false properties: reason: description: 取消运行的原因。 maxLength: 1000 type: string type: object description: 没有要说明的原因时，发送 `{}`。 required: true responses: '200': content: application/json: examples: success: summary: 响应示例 value: canceled_at: '2026-10-20T10:20:00Z' checkpoint: preview-staged completed_at: '2026-10-20T10:20:00Z' created_at: '2026-10-20T10:00:00Z' cursor: null execution_attempts: 1 failure: null id: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b kind: crawl-preview knowledge_space_id: 0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d last_error_code: null max_execution_attempts: 5 progress_completed: 37 progress_failed: 0 progress_skipped: 0 progress_total: 37 source_id: 6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90 state: canceled updated_at: '2026-10-20T10:20:00Z' schema: $ref: '#/components/schemas/KnowledgeBaseSourceRun' description: '取消后的运行：`state: canceled`，`canceled_at` 和 `completed_at` 均已设置。' '400': content: application/json: examples: knowledge_fs_invalid_request_local: summary: knowledge_fs_invalid_request (request validation) value: code: knowledge_fs_invalid_request message: Agent Knowledge Base request is invalid. status: 400 violations: - field: - reason type: string_too_long knowledge_fs_invalid_request_path: summary: knowledge_fs_invalid_request (path ID) value: code: knowledge_fs_invalid_request message: Agent Knowledge Base request is invalid. status: 400 knowledge_fs_invalid_request_upstream: summary: knowledge_fs_invalid_request (rejected) value: code: knowledge_fs_invalid_request failure: category: validation code: KNOWLEDGE_FS_INVALID_REQUEST message: The Agent Knowledge Base request is invalid. retryPolicy: never traceId: 7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83 message: The Agent Knowledge Base request is invalid. status: 400 description: >- - `knowledge_fs_invalid_request`：请求未通过校验。`violations` 列出每个出错的字段。`reason` 超过 1,000 个字符，或请求体含有其他任何键，都属于此类。 - `knowledge_fs_invalid_request`：`run_id` 不是 UUID。 - `knowledge_fs_invalid_request`：该运行的数据源正在删除或已不存在。 - `knowledge_fs_invalid_request`：`run_id` 格式不正确。 '401': content: application/json: examples: knowledge_fs_invalid_credential: summary: knowledge_fs_invalid_credential value: code: knowledge_fs_invalid_credential message: Invalid Agent Knowledge Base service credential. status: 401 unauthorized: summary: unauthorized value: code: unauthorized message: Access token is invalid status: 401 description: >- - `unauthorized`：缺少 `Authorization` 请求头，或密钥无法识别、不是知识库 API 密钥。 - `knowledge_fs_invalid_credential`：密钥有效，但其所属工作空间中没有此 ID 的知识库，或该密钥未关联任何工作空间。 '403': content: application/json: examples: forbidden: summary: forbidden (rate limit) value: code: forbidden message: >- Sorry, you have reached the knowledge base request rate limit of your subscription. status: 403 knowledge_fs_access_denied_scope: summary: knowledge_fs_access_denied (key scope) value: code: knowledge_fs_access_denied message: Agent Knowledge Base operation is not allowed. status: 403 description: >- - `knowledge_fs_access_denied`：该密钥的访问范围限定为其他知识库、此知识库已关闭 **API 访问**，或知识库未处于活动状态。 - `forbidden`：在 Dify Cloud 上，工作空间已达到其订阅套餐的知识库请求频率限制。所有调用都计入，读取操作也不例外。 '404': content: application/json: examples: knowledge_fs_resource_not_found: summary: knowledge_fs_resource_not_found value: code: knowledge_fs_resource_not_found failure: category: not_found code: KNOWLEDGE_FS_NOT_FOUND message: >- The requested Agent Knowledge Base resource was not found. retryPolicy: never traceId: 7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83 message: The requested Agent Knowledge Base resource was not found. status: 404 not_found: summary: not_found (feature off) value: code: not_found message: >- The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again. status: 404 description: |- - `knowledge_fs_resource_not_found`：此知识库中不存在该 ID 的运行，或该密钥无权读取其数据源。 - `not_found`：当前部署已关闭 Agent 知识库功能。 '409': content: application/json: examples: knowledge_fs_conflict: summary: knowledge_fs_conflict value: code: knowledge_fs_conflict failure: action: retry category: conflict code: KNOWLEDGE_FS_CONFLICT message: >- The Agent Knowledge Base operation conflicts with the current resource state. retryPolicy: manual traceId: 7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83 message: >- The Agent Knowledge Base operation conflicts with the current resource state. status: 409 description: >- - `knowledge_fs_conflict`：该运行的状态为 `failed`。可用 [重试数据源运行](/zh/api-reference/source-syncs-and-imports/retry-source-run) 重试，或不做处理。 '502': content: application/json: examples: knowledge_fs_upstream_unavailable: summary: knowledge_fs_upstream_unavailable (service error) value: code: knowledge_fs_upstream_unavailable failure: action: contact_admin category: internal code: KNOWLEDGE_FS_INTERNAL_ERROR message: >- Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference. retryPolicy: manual traceId: 5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b message: >- Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference. status: 502 knowledge_fs_upstream_unavailable_transport: summary: knowledge_fs_upstream_unavailable (no response) value: code: knowledge_fs_upstream_unavailable message: Agent Knowledge Base is unavailable. status: 502 description: >- - `knowledge_fs_upstream_unavailable`：未能及时收到响应，或无法读取响应。 取消可能已经生效。再次取消前，先用 [获取数据源运行](/zh/api-reference/source-syncs-and-imports/get-source-run) 读取该运行。 '503': content: application/json: examples: knowledge_fs_operation_unavailable: summary: knowledge_fs_operation_unavailable value: code: knowledge_fs_operation_unavailable message: Agent Knowledge Base operation is not available. status: 503 knowledge_fs_operation_unavailable_upstream: summary: knowledge_fs_operation_unavailable (temporary) value: code: knowledge_fs_operation_unavailable failure: action: retry category: dependency code: KNOWLEDGE_FS_UNAVAILABLE message: >- A service required by Agent Knowledge Base is temporarily unavailable. retryPolicy: manual traceId: 5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b message: >- A service required by Agent Knowledge Base is temporarily unavailable. status: 503 description: >- - `knowledge_fs_operation_unavailable`：此工作空间尚未配置 Agent 知识库功能、当前部署不提供此操作，或在请求鉴权期间该密钥对此知识库的访问权限发生了变化。 - `knowledge_fs_operation_unavailable`：暂时无法处理该请求。按 `failure.retryPolicy` 处理。 components: schemas: KnowledgeBaseSourceRun: properties: canceled_at: description: 取消运行的时间。仅当 `state` 为 `canceled` 时有值，否则为 `null`。 nullable: true type: string checkpoint: description: >- 运行已到达的最后一步：`queued`、`provider-read`、`preview-staged`、`selection-frozen`、`materialized`、`cleanup-staging` 或 `source-committed`。无论运行停在哪个检查点，[重试数据源运行](/zh/api-reference/source-syncs-and-imports/retry-source-run) 都会从头开始运行。 type: string completed_at: description: >- 运行结束（`completed`、`zero_results`、`failed` 或 `canceled`）的时间，ISO 8601 格式。运行期间为 `null`。 nullable: true type: string created_at: description: 创建时间，ISO 8601 格式。 type: string cursor: description: 运行恢复时所用的提供商游标。运行尚未翻页时为 `null`。 nullable: true type: string execution_attempts: description: >- 工作进程领取该运行的次数，包括 [重试数据源运行](/zh/api-reference/source-syncs-and-imports/retry-source-run) 之后的领取，重试不会重置该值。 type: integer failure: allOf: - $ref: '#/components/schemas/KnowledgeBaseErrorDetails' description: >- `state` 为 `failed` 时的错误详情。其中 `stage` 为失败时运行的 `checkpoint`，`traceId` 为运行 ID。其他情况下为 `null`。 nullable: true id: description: >- 运行 ID，可传给 [获取数据源运行](/zh/api-reference/source-syncs-and-imports/get-source-run)、[取消数据源运行](/zh/api-reference/source-syncs-and-imports/cancel-source-run) 或 [重试数据源运行](/zh/api-reference/source-syncs-and-imports/retry-source-run)。 type: string kind: description: >- 运行的类型： - `sync`：由 [同步数据源](/zh/api-reference/source-syncs-and-imports/sync-source)、[更新数据源](/zh/api-reference/sources/update-source)、定时同步或 Dify 发起。 - `crawl-preview`：由 [预览网站抓取](/zh/api-reference/source-syncs-and-imports/preview-website-crawl) 发起。[导入所选页面](/zh/api-reference/source-syncs-and-imports/import-selected-pages) 从该预览导入时，类型保持不变。 - `crawl-import`：由 [导入网站页面](/zh/api-reference/source-syncs-and-imports/import-website-pages) 发起。 - `online-document-import`、`online-drive-import`：由 [导入数据源条目](/zh/api-reference/source-syncs-and-imports/import-source-items) 发起。 在 Dify 中添加或编辑数据源时，Dify 也会发起预览和导入。 type: string knowledge_space_id: description: 知识库的内部 ID，并非路径中的知识库 ID。 type: string last_error_code: description: '`state` 为 `failed` 时为 `failure.code` 的值，否则为 `null`。' nullable: true type: string max_execution_attempts: description: >- `execution_attempts` 的上限。达到上限后，[重试数据源运行](/zh/api-reference/source-syncs-and-imports/retry-source-run) 返回 `409`。 type: integer progress_completed: description: 已处理完的项数，包括同步时检查过但未变化的项。 type: integer progress_failed: description: 数据源运行始终为 `0`：任一项失败都会导致整个运行失败。 type: integer progress_skipped: description: 数据源运行始终为 `0`。 type: integer progress_total: description: >- 运行预计处理的项数：导入请求的页面或条目数、抓取预览目前已暂存的页面数，或同步列出数据源条目后的条目数。确定之前为 `null`。 [导入网站页面](/zh/api-reference/source-syncs-and-imports/import-website-pages) 的运行抓取 URL 期间，`progress_completed` 和 `progress_total` 都统计目前已抓取的页面数。所有 URL 抓取完成后，进度从 `0` 重新开始计，总数变为 URL 的数量。 nullable: true type: integer source_id: description: 运行所属的数据源。 nullable: true type: string state: description: >- 运行的进度。 进行中的状态： - `queued`：等待工作进程处理 - `crawling`：抓取预览正在获取页面 - `preview_ready`：抓取预览正在等待 [导入所选页面](/zh/api-reference/source-syncs-and-imports/import-selected-pages) 或 [取消数据源运行](/zh/api-reference/source-syncs-and-imports/cancel-source-run) - `importing`：正在导入并索引条目 - `syncing`：正在刷新数据源的文档 终态： - `completed`：所有条目均已导入或刷新、完成索引并生效 - `zero_results`：抓取预览未找到任何页面 - `failed`：详见 `failure` - `canceled` `failed` 或 `canceled` 之后，[重试数据源运行](/zh/api-reference/source-syncs-and-imports/retry-source-run) 会再次执行该运行，[同步数据源](/zh/api-reference/source-syncs-and-imports/sync-source) 则会发起新的同步。 type: string updated_at: description: 最后变更时间，ISO 8601 格式。 type: string type: object KnowledgeBaseErrorDetails: properties: action: description: >- 建议的下一步操作（如有）：`configure_model`、`configure_parser`、`configure_source`、`contact_admin`、`reupload` 或 `retry`。不适用时为 `null`。HTTP 错误响应体中不包含此字段。 nullable: true type: string category: description: >- 失败类别：`authorization`、`canceled`、`configuration`、`conflict`、`dependency`、`internal`、`not_found`、`rate_limit`、`timeout` 或 `validation`。 type: string code: description: >- 稳定的错误码，采用大写蛇形命名，例如 `KNOWLEDGE_FS_CONFLICT` 或 `SOURCE_CREDENTIAL_TEST_FAILED`。 type: string message: description: 错误码或失败类别对应的公开消息。不会暴露提供商的错误详情。 type: string parameters: additionalProperties: true description: >- 描述失败细节的值，最多 8 个，键取自 `attempt`、`currentRowVersion`、`documentCount`、`expectedRowVersion`、`fileSizeBytes`、`limit`、`maxFileSizeBytes`、`maxItems`、`modelType`、`providerKind`、`retryAfterSeconds` 和 `status`。没有时为 `null`。HTTP 错误响应体中不包含此字段。 nullable: true type: object retryPolicy: description: >- 重试是否有用：`automatic`（服务会自动重试）、`manual`（需自行重试）、`after_configuration`（先在 Dify 中修正知识库配置）或 `never`（需修改请求）。 type: string stage: description: >- 失败所在的阶段，例如 `query_generation` 或 `credential-test`。不适用时为 `null`。HTTP 错误响应体中不包含此字段。 nullable: true type: string traceId: description: 联系管理员时需提供的参考编号。在包含失败详情的成功响应中可能为 `null`，在 HTTP 错误响应体中可能不出现。 nullable: true type: string type: object securitySchemes: ApiKeyAuth: bearerFormat: API_KEY description: >- 每个请求都通过 API Key 认证：`Authorization: Bearer {API_KEY}`。应用接口使用应用 API Key，知识库接口使用知识库 API Key（[快速开始](/zh/api-reference/guides/get-started)）。 API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP `401`（`unauthorized`）。 scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.