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

Cloud Parallel File Storage:CreateDataFlowTask

最終更新日:Jul 22, 2026

データフロータスクを作成します。

操作説明

  • CPFS の使用上の注意

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

    • データフロータスクは非同期で実行されます。 DescribeDataFlowTasks を呼び出して、タスク実行ステータスをクエリできます。タスクに必要な時間は、インポートまたはエクスポートするデータ量によって異なります。large なデータが関わる場合は、データを複数のタスクにコスト配分してください。

    • データフロータスクは、Running 状態のデータフローに対してのみ作成できます。

    • データフロータスクを手動で実行すると、データフローの自動データ更新タスクが中断され、待機状態になります。

    • エクスポートタスクを作成する際は、CPFS からエクスポートするファイルの絶対パスの合計長さが 1,023 文字を超えないことを確認してください。

  • Lingjun 向け CPFS の使用上の注意

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

    • データフロータスクは非同期で実行されます。 DescribeDataFlowTasks を呼び出して、タスク実行ステータスをクエリできます。タスクに必要な時間は、インポートまたはエクスポートするデータ量によって異なります。large なデータが関わる場合は、データを複数のタスクにコスト配分してください。

    • データフロータスクは、Running 状態のデータフローに対してのみ作成できます。

    • エクスポートタスクを作成する際は、Lingjun 向け CPFS からエクスポートするファイルの絶対パスの合計長さが 1,023 文字を超えないことを確認してください。

    • Lingjun 向け CPFS は、バッチタスクとストリームタスクの 2 つのタスクタイプをサポートしています。詳細については、「タスクタイプの概要」を参照してください。

今すぐお試しください

この 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:CreateDataFlowTask

create

*DataFlow

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

FileSystemId

string

必須

ファイルシステム ID。

  • 汎用 CPFS: cpfs- で始まる必要があります (例: cpfs-125487****)。

  • Lingjun 向け CPFS: bmcpfs- で始まる必要があります (例: bmcpfs-0015****)。

cpfs-099394bd928c****

DataFlowId

string

必須

データフロー ID。

df-194433a5be31****

SrcTaskId

string

任意

SrcTaskId を指定する場合は、データフロータスク ID を入力します。システムは、指定されたデータフロータスクから TaskAction、DataType、および EntryList パラメーター情報をコピーするため、これらのパラメーターを個別に指定する必要はありません。

説明

データフローストリームタスクはサポートされていません。

task-29ee8e890f45****

ClientToken

string

任意

リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。

トークンには ASCII 文字のみを使用でき、長さは 64 文字以下である必要があります。詳細については、「べき等性を確保する方法」を参照してください。

説明

このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。RequestId は API 呼び出しごとに異なる場合があります。

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

DryRun

boolean

任意

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

ドライランでは、パラメーターの有効性と必要なリソースが利用可能かどうかがチェックされます。ドライランではインスタンスの作成や料金の発生は行われません。

有効な値:

  • true: インスタンスを作成せずにドライランを実行します。システムは、必須のパラメーターが指定されているか、リクエストフォーマットが有効か、サービス制限に達していないか、および必要な NAS リソースが利用可能かどうかをチェックします。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに成功した場合、HTTP 状態コード 200 が返されますが、TaskId は空になります。

  • false (デフォルト): ドライランを実行し、リクエストを送信します。リクエストがドライランに成功した場合、インスタンスが作成されます。

false。

TaskAction

string

任意

データフローノードタイプ。

有効な値:

  • Import: ソースストレージから CPFS へのデータインポートを実行します。

  • Export: 指定されたデータを CPFS からソースストレージへエクスポートします。

  • StreamImport: 指定されたデータをソースストレージから CPFS へバッチインポートします。

  • StreamExport: 指定されたデータを CPFS からソースストレージへバッチエクスポートします。

  • Evict: CPFS 上のファイルのデータブロックをリリースします。リリース後、CPFS 上にはメタデータのみが保持されます。ファイルのクエリは引き続き可能ですが、データブロックは削除され、CPFS 上のストレージ容量を占有しません。ファイルデータにアクセスすると、データはソースストレージからオンデマンドでロードされます。

  • Inventory: CPFS 上のデータストリームによって管理されるファイルのチェックリストを取得します。このチェックリストは、データフロー内のファイルのキャッシュステータスを提供します。

説明

Lingjun 向け CPFS は、Import、Export、StreamImport、および StreamExport のみをサポートしています。StreamImport と StreamExport は、Lingjun 向け CPFS 2.6.0 以降でのみサポートされています。

列挙値:

  • StreamExport :

    指定されたデータを CPFS からソースストレージへバッチエクスポートします。

  • Import :

    ソースストレージから CPFS へのデータインポートを実行します。

  • StreamImport :

    指定されたデータをソースストレージから CPFS へバッチインポートします。

  • Export :

    指定されたデータを CPFS からソースストレージへエクスポートします。

  • Evict :

    CPFS 上のファイルのデータブロックをリリースします。リリース後、CPFS 上にはメタデータのみが保持されます。

  • Inventory :

    CPFS 上のデータフローによって管理されるファイルリストを取得します。このリストは、データフロー内のファイルのキャッシュステータスを提供します。

Import。

DataType

string

任意

データフロータスクが操作するデータの型。

有効な値:

  • Metadata: ファイルのメタデータ (タイムスタンプ、所有権、権限、その他の属性を含む)。Metadata を選択した場合、ファイルのメタデータのみがインポートされます。ファイルをビューすることはできますが、ファイルデータにアクセスすると、データはソースストレージからオンデマンドでロードされます。

  • Data: ファイルのデータブロック。

  • MetaAndData: ファイルのメタデータとデータブロック。

説明

TaskAction が Evict にセットされている場合、DataType パラメーターは必須です。

列挙値:

  • :
  • Metadata :

    ファイルのメタデータ。

  • Data :

    ファイルのデータブロック。

  • MetaAndData :

    ファイルのメタデータとデータブロック。

Metadata。

Directory

string

任意

データのソースディレクトリ。

使用制限:

  • 値の長さは 1~1,023 文字である必要があります。

  • 値は UTF-8 でエンコードされている必要があります。

  • 値はスラッシュ (/) で始まり、スラッシュ (/) で終わる必要があります。

  • 一度に指定できるディレクトリは 1 つだけです。

  • TaskAction が Export に設定されている場合、このディレクトリは FileSystemPath 内の相対パスである必要があります。

  • TaskAction が Import に設定されている場合、このディレクトリは SourceStoragePath 内の相対パスである必要があります。

  • TaskAction が StreamExport に設定されている場合、このディレクトリは FileSystemPath 内の相対パスである必要があります。

  • TaskAction が StreamImport に設定されている場合、このディレクトリは SourceStoragePath 内の相対パスである必要があります。

説明

StreamImport と StreamExport は、Lingjun 向け CPFS 2.6.0 以降でのみサポートされています。 Directory、EntryList、および TransferFileListPath は相互排他的なパラメーターです。いずれか 1 つのみを指定できます。

/path_in_cpfs/

EntryList

string

任意

データフロータスクが実行されるファイルのリスト。

使用制限:

  • 値は UTF-8 でエンコードされている必要があります。

  • ファイルリストの合計長さは 64 KB 未満である必要があります。

  • ファイルリストは JSON フォーマットです。

  • 各ファイルのパスの長さは 1~1,023 文字であり、スラッシュ (/) で始まる必要があります。

  • TaskAction が Import に設定されている場合、リスト内の各要素は OSS オブジェクト名を表します。

  • TaskAction が Export に設定されている場合、リスト内の各要素は CPFS ファイルパスを表します。

説明

Directory、EntryList、および TransferFileListPath は相互排他的なパラメーターです。いずれか 1 つのみを指定できます。

["/path_in_cpfs/file1", "/path_in_cpfs/file2"]

TransferFileListPath

string

任意

OSS ディレクトリ。OSS ディレクトリ内の CSV ファイルの内容に基づいてデータが転送されます。使用制限:

  • 値はスラッシュ (/) で始まり、スラッシュ (/) で終わる必要があります。

  • 値は大文字と小文字が区別されます。

  • 値の長さは 1~1,023 文字である必要があります。

  • 値は UTF-8 でエンコードされている必要があります。

説明
  • TransferFileListPath、Directory、および EntryList は相互排他的なパラメーターです。いずれか 1 つのみを指定できます。

  • このパラメーターは OSS 内の既存のパスを指定します。パス内の *.csv ファイルは OSS に保存されています。

  • TransferFileListPath は Import と Export のみをサポートしています。

  • Import シナリオでは、CSV ファイルで指定されたファイルまたはディレクトリが OSS から CPFS にインポートされます。

  • Export シナリオでは、CSV ファイルで指定されたファイルまたはディレクトリが CPFS から OSS にエクスポートされます。

  • CSV ファイル形式には Name 列と Type 列を含める必要があります。Name は相対パスであり、Type は dir と file の 2 つの値をサポートします。Type が dir の場合、Name の値はスラッシュ (/) で終わる必要があります。

  • この特徴は Lingjun 向け CPFS のみでサポートされています。

/test_oss_path/

Includes

string

任意

指定されたディレクトリ配下のディレクトリをフィルタリングし、含まれるフォルダの内容を転送します。

説明
  • このパラメーターは、Directory パラメーターが指定されている場合にのみ効果があります。

  • 各フォルダのパスの長さは 1~1,023 文字であり、スラッシュ (/) で始まり、スラッシュ (/) で終わる必要があります。合計長さは 3,000 文字を超えることはできません。

  • この特徴は Lingjun 向け CPFS のみでサポートされています。

["/test/","/test1/"]

DstDirectory

string

任意

データフロータスクがマッピングするターゲットディレクトリ。 使用制限:

  • 値はスラッシュ (/) で始まり、スラッシュ (/) で終わる必要があります。/../ はサポートされていません。

  • 値の長さは 1~1,023 文字である必要があります。

  • 値は UTF-8 でエンコードされている必要があります。

  • 一度に指定できるディレクトリは 1 つだけです。

  • TaskAction が Export に設定されている場合、このディレクトリは SourceStoragePath 内の相対パスである必要があります。

  • TaskAction が Import に設定されている場合、このディレクトリは FileSystemPath 内の相対パスである必要があります。

  • TaskAction が StreamExport に設定されている場合、このディレクトリは SourceStoragePath 内の相対パスである必要があります。

  • TaskAction が StreamImport に設定されている場合、このディレクトリは FileSystemPath 内の相対パスである必要があります。

説明

StreamImport と StreamExport は、Lingjun 向け CPFS 2.6.0 以降でのみサポートされています。

/path_in_cpfs/

CreateDirIfNotExist

boolean

任意

フォルダが存在しない場合に自動作成を有効にするかどうかを指定します。 有効な値:

  • true: フォルダの自動作成を有効にします。

  • false (デフォルト): フォルダの自動作成を有効にしません。

説明
  • このパラメーターは、TaskAction が Import に設定されている場合に効果があります。

  • この特徴は Lingjun 向け CPFS 2.6.0 以降でのみサポートされています。

false。

ConflictPolicy

string

任意

同名ファイルの競合ポリシー。 有効な値:

  • SKIP_THE_FILE: 同名のファイルをスキップします。

  • KEEP_LATEST: 更新時間を比較し、最新バージョンを保持します。

  • OVERWRITE_EXISTING: 同名のファイルを強制的に上書きします。

説明

ファイルシステムタイプが Lingjun 向け CPFS の場合、このパラメーターは必須です。

SKIP_THE_FILE。

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

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

TaskId

string

データフロータスク ID。

task-38aa8e890f45****

成功レスポンス

JSONJSON

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "TaskId": "task-38aa8e890f45****"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 IllegalCharacters The parameter contains illegal characters. 指定されたパラメーターが無効です。
400 MissingFileSystemId FileSystemId is mandatory for this action. FileSystemId パラメーターが指定されていません。
400 MissingDataFlowId DataFlowId is mandatory for this action. DataFlowId パラメーターが指定されていません。
400 InvalidFilesystemVersion.NotSupport This Api does not support this fileSystem version. 現在の操作はこのバージョンのファイルシステムをサポートしていません。
403 OperationDenied.InvalidState The operation is not permitted when the status is processing. 現在のファイルシステムステータスでは、この操作はサポートされていません。
403 OperationDenied.DependencyViolation The operation is denied due to dependancy violation. この操作の条件を満たしていません。
403 OperationDenied.DataFlowNotSupported The operation is not supported. ファイルシステムはデータフローをサポートしていません。
404 InvalidParameter.InvalidFormat The EntryList format is invalid. 指定された EntryList のフォーマットが要件を満たしていません。
404 InvalidParameter.SizeTooLarge The specified EntryList size exceeds 64 KB. 指定された EntryList のサイズが 64 KB を超えています。
404 InvalidDataFlow.NotFound The specified data flow does not exist. 指定されたデータフローが存在しません。
404 InvalidTaskAction.NotSupported The task action is not supported. 指定されたタスクタイプはサポートされていません。
404 InvalidTaskAction.PermissionDenied The task action is not allowed. 指定されたタスクタイプ (システムレプリケーションなど) は許可されていません。
404 InvalidSrcTaskId.NotFound The SrcTaskId is not found. 指定された SrcTaskId が存在しません。
404 InvalidDataType.NotSupported The data type is not supported. 指定されたデータの型はサポートされていません。
404 InvalidSrcTaskId.TaskIdInvalid Source task ID is invalid. コピー対象として指定されたタスク ID が無効です。
404 InvalidSrcTaskId.TaskIdNotFound Source task ID is not found. コピー対象として指定されたタスク ID が存在しません。

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

変更履歴

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