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

# ワークフロータスクを停止

> **対象アプリ**：Workflow。

実行中のタスクを停止します。

停止は冪等で、タスクについて何も明かしません。完了済みのタスク、存在しないタスク、別の API キーのタスクを停止した場合も `{"result": "success"}` が返りますが、実際には何も停止しません。

**標準 API の対応する操作**：[ワークフロータスクを停止](/ja/3.13.x/develop/api/workflow-runs/stop-workflow-task)。契約は同じで、認証と可用性に関するエラーだけが異なります。



## OpenAPI

````yaml /ja/3.13.x/develop/api/openapi_service.json post /v2/workflows/tasks/{task_id}/stop
openapi: 3.0.1
info:
  title: Dify サービス API
  description: >-
    Dify アプリケーションとナレッジベースのための REST API です。アプリケーション系エンドポイントはアプリの API
    キーで、ナレッジ系エンドポイントはナレッジベースの API キーで認証します。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: Dify サービス API のベース URL です。ご利用のデプロイ環境の API ベース URL に置き換えてください。
    variables:
      api_base_url:
        default: api.example.com/v1
        description: API ベース URL のホストとパス（`https://` を除く）。
security:
  - ApiKeyAuth: []
tags:
  - 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: >-
      デプロイ環境が `v2` ベース URL
      で提供するエンドポイントです。デプロイ環境が提供するのはこのグループのエンドポイントだけで、それ以外のパスを呼び出すと `404
      not_found` が返ります。認証とエラーは標準の Service API
      とは異なります。デプロイ環境については、このグループの各ページが正式な情報源です。
paths:
  /v2/workflows/tasks/{task_id}/stop:
    post:
      tags:
        - デプロイ環境
      summary: ワークフロータスクを停止
      description: >-
        **対象アプリ**：Workflow。


        実行中のタスクを停止します。


        停止は冪等で、タスクについて何も明かしません。完了済みのタスク、存在しないタスク、別の API キーのタスクを停止した場合も
        `{"result": "success"}` が返りますが、実際には何も停止しません。


        **標準 API
        の対応する操作**：[ワークフロータスクを停止](/ja/3.13.x/develop/api/workflow-runs/stop-workflow-task)。契約は同じで、認証と可用性に関するエラーだけが異なります。
      operationId: stopDeployedWorkflowTaskJa
      parameters:
        - name: task_id
          in: path
          required: true
          description: >-
            タスク ID
            です。[ワークフローを実行](/ja/3.13.x/develop/api/deployed-environments/run-workflow)
            のレスポンスまたはストリーミングイベントから取得します。
          schema:
            type: string
            format: uuid
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                user:
                  type: string
                  description: >-
                    エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。互換性のために受け付けますが、停止の認可は API
                    キーとタスクだけで行われます。[エンドユーザーの識別](/ja/3.13.x/develop/api/guides/end-user-identity)
                    を参照してください。
            examples:
              example:
                summary: リクエスト例
                value:
                  user: user_workflow_123
      responses:
        '200':
          description: 停止リクエストを受け付けました。
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    description: 常に `success` です。
              examples:
                ok:
                  summary: レスポンス例
                  value:
                    result: success
        '400':
          description: >-
            `invalid_request`：停止リクエストのワークスペース、アプリ、環境のいずれかがデプロイと一致しません。管理者にデプロイのルーティングの確認を依頼してください。
          content:
            application/json:
              examples:
                invalid_request:
                  summary: invalid_request
                  value:
                    code: invalid_request
                    message: runtime route identity does not match task identity
                    status: 400
        '401':
          description: >-
            - `token_invalid`：API キーがない、形式が不正、または不明です。

            - `unauthorized`：API キーが取り消されています。

            - `runtime_identity_invalid`：リクエストの署名付き ID
            がタスクと一致しません。リクエストを送り直してください。
          content:
            application/json:
              examples:
                token_invalid:
                  summary: token_invalid
                  value:
                    code: token_invalid
                    message: invalid api token
                    status: 401
                unauthorized:
                  summary: unauthorized
                  value:
                    code: unauthorized
                    message: Access token is invalid
                    status: 401
                runtime_identity_invalid:
                  summary: runtime_identity_invalid
                  value:
                    code: runtime_identity_invalid
                    message: runtime identity is invalid
                    status: 401
        '403':
          description: '`forbidden`：**アクセスポイント** で、アプリの API アクセスが無効になっています。'
          content:
            application/json:
              examples:
                forbidden:
                  summary: forbidden
                  value:
                    code: forbidden
                    message: The app's API service has been disabled.
                    status: 403
        '404':
          description: '`not_found`：`task_id` が正規形の小文字 UUID ではありません。'
          content:
            application/json:
              examples:
                not_found:
                  summary: not_found
                  value:
                    code: not_found
                    message: unsupported appdeploy service api endpoint
                    status: 404
        '503':
          description: >-
            - `deployment_undeployed`：この環境からアプリがアンデプロイされています。

            - `deployment_not_ready`：デプロイが進行中です。しばらくしてから再試行してください。

            - `apprunner_not_deployed`：環境が利用できません。環境の削除中などに発生します。

            -
            `enterprise_unavailable`：プラットフォーム側のルーティングサービスが一時的に利用できません。しばらくしてから再試行してください。

            -
            `service_not_ready`：環境が停止を実行できませんでした。タスクのバージョンがこの環境にもうデプロイされていない場合などに発生します。しばらくしてから再試行してください。
          content:
            application/json:
              examples:
                deployment_undeployed:
                  summary: deployment_undeployed
                  value:
                    code: deployment_undeployed
                    message: deployment is not deployed
                    status: 503
                deployment_not_ready:
                  summary: deployment_not_ready
                  value:
                    code: deployment_not_ready
                    message: deployment is in progress
                    status: 503
                apprunner_not_deployed:
                  summary: apprunner_not_deployed
                  value:
                    code: apprunner_not_deployed
                    message: apprunner not deployed for this environment
                    status: 503
                enterprise_unavailable:
                  summary: enterprise_unavailable
                  value:
                    code: enterprise_unavailable
                    message: enterprise routing service unavailable
                    status: 503
                service_not_ready:
                  summary: service_not_ready
                  value:
                    code: service_not_ready
                    message: task revision is not assigned to this runner
                    status: 503
      servers:
        - url: https://{deployed_api_base_url}
          description: >-
            すべてのデプロイ環境が共有するベース URL です。標準の Service API アドレスで `/v1` を `/v2`
            に置き換えたものです。
          variables:
            deployed_api_base_url:
              default: api.example.com
              description: >-
                アプリの **アクセスポイント** タブで、いずれかのデプロイ環境の **バックエンドサービス API** カードから完全な
                URL をコピーし、先頭の `https://` と末尾の `/v2` を除いてください。
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        すべてのリクエストは API キーで認証します：`Authorization: Bearer
        {API_KEY}`。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API
        キーを使用します（[Dify API
        クイックスタート](/ja/3.13.x/develop/api/guides/get-started)）。


        キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP
        `401`（`unauthorized`）で失敗します。

````