すべてのプロダクト
Search
ドキュメントセンター

Cloud Parallel File Storage:CancelDataFlowTask

最終更新日:May 22, 2026

Pending 状態のバッチまたはストリーミングデータフロータスクをキャンセルします。

操作説明

  • データフロータスクは、CPFS 2.2.0 以降および CPFS-EHPC 2.4.0 以降でのみサポートされています。バージョン情報は、コンソールのファイルシステム詳細ページで確認できます。

  • キャンセルできるデータフロータスクは、Pending 状態のもののみです。

  • データフロータスクのキャンセルには通常 5 ~ 10 分かかります。タスクの実行ステータスを確認するには、DescribeDataFlowTasks API を呼び出してください。

  • 実行中のサブタスクがある場合、ストリーミングデータフロータスクをキャンセルすることはできません。この場合、OperationDenied.DependencyViolation エラーが返されます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

nas:CancelDataFlowTask

delete

*DataFlow

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

FileSystemId

string

必須

ファイルシステムの ID。

  • 汎用 CPFS ファイルシステムの場合、ID は cpfs- で始まります (例:cpfs-125487****)。

  • CPFS-EHPC ファイルシステムの場合、ID は bmcpfs- で始まります (例:bmcpfs-0015****)。

cpfs-099394bd928c****

DataFlowId

string

必須

データフローの ID。

df-194433a5be31****

TaskId

string

必須

データフロータスクの ID。

task-38aa8e890f45****

DryRun

boolean

任意

ドライランを実行するかどうかを指定します。

ドライランでは、実際にタスクをキャンセルしたり料金を発生させたりすることなく、パラメーターの妥当性やリソースの可用性などの問題をチェックします。

有効な値:

  • true:タスクをキャンセルせずにドライランを実行します。システムは、必須パラメーター、リクエスト形式、ビジネス制限、NAS インベントリをチェックします。チェックに失敗した場合、システムはエラーを返します。チェックに合格した場合、システムは HTTP 200 OK レスポンスを返します。

  • false (デフォルト):通常のリクエストを送信し、妥当性チェックに合格した後にタスクをキャンセルします。

false

ClientToken

string

任意

リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントは、リクエスト間で一意の値を生成してください。

クライアントトークンは、64 文字以下の ASCII 文字列である必要があります。詳細については、「べき等性を保証する方法」をご参照ください。

説明

このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに一意であるため、再試行時にべき等性が保証されません。

123e4567-e89b-12d3-a456-42665544****

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

2D69A58F-345C-4FDE-88E4-BF518948****

成功レスポンス

JSONJSON

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 IllegalCharacters The parameter contains illegal characters.
400 MissingFileSystemId FileSystemId is mandatory for this action.
400 MissingDataFlowId DataFlowId is mandatory for this action.
400 MissingTaskId TaskId is mandatory for this action.
403 OperationDenied.ConflictOperation The operation is denied due to a conflict with an ongoing operation.
403 OperationDenied.DependencyViolation The operation is denied due to dependancy violation.
403 OperationDenied.DataFlowNotSupported The operation is not supported.
404 InvalidFileSystem.NotFound The specified file system does not exist.
404 InvalidDataFlow.NotFound The specified data flow does not exist.
404 InvalidTaskId.NotFound The specified task ID does not exist.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。