DescribeDataFlowTasks - Cloud Parallel File Storage - Alibaba Cloud ドキュメントセンター

データフロータスクの詳細を取得します。

操作説明

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

今すぐお試しください

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

get

*DataFlow

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FileSystemId	string	必須	ファイルシステムの ID です。 CPFS General-purpose Edition：ID は `cpfs-` で始まる必要があります。例：cpfs-099394bd928c**。 CPFS AI Computing Edition：ID は `bmcpfs-` で始まる必要があります。例：bmcpfs-290w65p03ok64ya**。	bmcpfs-290w65p03ok64ya****
Filters	array<object>	任意	フィルターの配列です。
	object	任意
Key	string	任意	フィルターキーの名前です。有効値： DataFlowIds：データフロー ID でフィルタリングします。 TaskIds：データフロータスク ID でフィルタリングします。 Originator：オリジネーターでフィルタリングします。 TaskActions：タスクタイプでフィルタリングします。 DataTypes：データタイプでフィルタリングします。 Status：ステータスでフィルタリングします。 CreateTimeBegin：指定した時刻以降に作成されたタスクをフィルタリングします。 CreateTimeEnd：指定した時刻以前に作成されたタスクをフィルタリングします。 StartTimeBegin：指定した時刻以降に開始されたタスクをフィルタリングします。 StartTimeEnd：指定した時刻以前に開始されたタスクをフィルタリングします。 EndTimeBegin：指定した時刻以降に終了したタスクをフィルタリングします。 EndTimeEnd：指定した時刻以前に終了したタスクをフィルタリングします。	DataFlowIds
Value	string	任意	フィルターキーの値です。このパラメーターはワイルドカードをサポートしていません。 `Key` が `DataFlowIds` に設定されている場合、1 つ以上のデータフロー ID を指定します。最大 10 個の ID を指定できます。例：`df-194433a5be31**` または `df-194433a512a2,df-234533a5be31`。 `Key` が `TaskIds` に設定されている場合、1 つ以上のデータフロータスク ID を指定します。最大 10 個の ID を指定できます。例：`task-38aa8e890f45` または `task-38aa8e890f45,task-29ae8e890f45`。 `Key` が `TaskActions` に設定されている場合、タスクタイプを指定します。有効値は、Import、Export、Evict、Inventory、StreamImport、StreamExport** です。複数の値を指定できます。CPFS AI Computing Edition は、Import、Export、StreamImport、StreamExport のみをサポートしていることにご注意ください。StreamImport と StreamExport は、CPFS AI Computing Edition 2.6.0 以降でのみサポートされています。 `Key` が `DataTypes` に設定されている場合、データタイプを指定します。有効値は、MetaAndData、Metadata、Data です。複数の値を指定できます。 `Key` が `Originator` に設定されている場合、タスクのオリジネーターを指定します。有効値は、User と System です。 `Key` が `Status` に設定されている場合、タスクのステータスを指定します。有効値は、Pending、Executing、Failed、Completed、Canceling、Canceled です。複数の値を指定できます。 `Key` が `CreateTimeBegin` に設定されている場合、クエリの最も早い作成時刻を指定します。時刻は `yyyy-MM-ddThh:mmZ` 形式で指定します。 `Key` が `CreateTimeEnd` に設定されている場合、クエリの最も遅い作成時刻を指定します。時刻は `yyyy-MM-ddThh:mmZ` 形式で指定します。 `Key` が `StartTimeBegin` に設定されている場合、クエリの最も早い開始時刻を指定します。時刻は `yyyy-MM-ddThh:mmZ` 形式で指定します。 `Key` が `StartTimeEnd` に設定されている場合、クエリの最も遅い開始時刻を指定します。時刻は `yyyy-MM-ddThh:mmZ` 形式で指定します。 `Key` が `EndTimeBegin` に設定されている場合、クエリの最も早い終了時刻を指定します。時刻は `yyyy-MM-ddThh:mmZ` 形式で指定します。 `Key` が `EndTimeEnd` に設定されている場合、クエリの最も遅い終了時刻を指定します。時刻は `yyyy-MM-ddThh:mmZ` 形式で指定します。	df-194433a5be31****
NextToken	string	任意	ページネーショントークンです。リクエストのレスポンスが切り捨てられた場合、後続のリクエストにこのトークンを含めることで、結果の次のページを取得します。	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	integer	任意	1 回のリクエストで返す結果の最大数です。値の範囲：10～100。デフォルト値：20。	20
WithReports	boolean	任意	レポート情報を返すかどうかを指定します。 True (デフォルト)：レポート情報を返します。 False：レポート情報を返しません。説明クエリパフォーマンスを向上させるには、このパラメーターを `False` に設定してください。このパラメーターは、CPFS AI Computing Edition でのみサポートされています。	True

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	2D69A58F-345C-4FDE-88E4-BF518948****
NextToken	string	レスポンスが切り捨てられた場合、ページネーショントークンが返されます。次のリクエストでこのトークンを使用して、結果の次のページを取得できます。	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
TaskInfo	object
Task	array<object>	データフロータスクのリストです。
	array<object>
FilesystemId	string	ファイルシステムの ID です。	bmcpfs-290w65p03ok64ya****
DataFlowId	string	データフローの ID です。	df-194433a5be31****
TaskId	string	データフロータスクの ID です。	task-38aa8e890f45****
SourceStorage	string	ソースストレージのアクセスパスです。フォーマット：`<storage type>://[<account id>:]<path>`。パラメーター： storage type：OSS のみをサポートしています。 account id：ソースストレージが属するアカウントの UID です。 path：OSS バケットの名前です。名前は次の要件を満たす必要があります：小文字、数字、ハイフン (-) のみを含み、小文字または数字で開始および終了する必要があります。長さは 128 文字以内である必要があります。 UTF-8 でエンコードされている必要があります。説明 OSS バケットは現在のリージョンに存在する必要があります。 account id パラメーターは、CPFS AI-Computing Edition 2.6.0 以降でのみサポートされています。	oss://178321033379****:bucket-01
FileSystemPath	string	CPFS ファイルシステム内のファイルセットのパスです。制限：パスは 2～1,024 文字で、英字と中国語の文字を含めることができます。パスは UTF-8 でエンコードされている必要があります。パスはスラッシュ (/) で開始および終了する必要があります。ディレクトリは、CPFS ファイルシステム上のファイルセットディレクトリである必要があります。説明このパラメーターは CPFS でのみサポートされています。	/a/b/c/
Originator	string	データフロータスクの実行元です。有効な値： User：ユーザーによって開始されたタスク。 System：CPFS が所定の間隔で自動的に開始する自動更新タスク。説明このパラメーターは CPFS でのみサポートされています。	User
TaskAction	string	データフロータスクのタイプです。有効な値： Import：ソースストレージから CPFS ファイルシステムに指定されたデータをインポートします。 Export：CPFS ファイルシステムからソースストレージに指定されたデータをエクスポートします。 StreamImport：ソースストレージから CPFS ファイルシステムにストリーミングデータをインポートします。 StreamExport：CPFS ファイルシステムからソースストレージにストリーミングデータをエクスポートします。 Evict：CPFS ファイルシステム上のファイルのデータブロックをエビクトし、メタデータのみを保持します。ファイルは引き続きクエリできますが、そのデータブロックはクリアされ、ストレージ容量を消費しなくなります。ファイルにアクセスすると、そのデータはオンデマンドでソースストレージからロードされます。 Inventory：データフローによって管理されている CPFS ファイルシステム上のファイルのインベントリを取得します。このインベントリは、ファイルのキャッシュステータスを示します。説明 StreamImport と StreamExport は、CPFS AI-Computing Edition 2.6.0 以降でのみサポートされています。	Import
DataType	string	データフロータスクが扱うデータのタイプです。有効な値： Metadata：ファイルのタイムスタンプ、所有権、権限などのメタデータです。この値を選択すると、メタデータのみがインポートされます。ファイルは表示されますが、そのデータはアクセス時にオンデマンドでソースストレージからロードされます。 Data：ファイルのデータブロックです。 MetaAndData：ファイルのメタデータとデータブロックです。説明 CPFS AI-Computing Edition は MetaAndData タイプのみをサポートします。	MetaAndData
Progress	integer	データフロータスクの進捗です。タスクで実行された操作の数を表します。	50
Status	string	データフロータスクのステータスです。有効な値： Pending：データフロータスクが作成され、実行を待っています。 Executing：データフロータスクは進行中です。 Failed：データフロータスクは失敗しました。データフロータスクのレポートを表示して、失敗の原因を特定できます。 Completed：データフロータスクは完了しました。データフロータスクのレポートを表示して、すべてのファイルが期待どおりに転送されたかどうかを確認できます。 Canceled：データフロータスクはキャンセルされ、完了していません。 Canceling：データフロータスクはキャンセル中です。	Failed
ReportPath `deprecated`	string	データフロータスクのレポートが保存される CPFS ファイルシステム内のパスです。 CPFS の場合、タスクレポートはファイルシステムの `.dataflow_report` ディレクトリに生成されます。 CPFS AI-Computing Edition の場合、このパラメーターはタスクレポートの OSS ダウンロードリンクを返します。このリンクを使用してタスクレポートをダウンロードできます。	/path_in_cpfs/reportfile.cvs
CreateTime	string	タスクが作成された時刻です。	2021-08-04 18:27:35
StartTime	string	タスクが開始された時刻です。	2021-08-04 18:27:35
EndTime	string	タスクが終了した時刻です。	2021-08-04 18:27:35
FsPath	string	インテリジェントディレクトリのパスです。	/aa/
ConflictPolicy	string	同名ファイルに対する競合ポリシーです。 SKIP_THE_FILE：同名のファイルをスキップします。 KEEP_LATEST：更新時刻を比較し、最新バージョンを保持します。 OVERWRITE_EXISTING：同名のファイルを強制的に上書きします。	KEEP_LATEST
Directory	string	データフロータスクが実行されるディレクトリです。	/path_in_cpfs/
DstDirectory	string	データフロータスクがマップされる宛先ディレクトリです。	/path_in_cpfs/
ErrorMsg	string	タスクエラーの原因です。説明このフィールドが返されないか空の場合、エラーが発生しなかったことを示します。	{"ErrorKey":"PATH_NOT_ACCESSIBLE","ErrorDetail":"lstat /cpfs/370lx1ev9ss27o****/test/abcdfnotfound: no such file or directory"}
ProgressStats	object	データフロータスクの進捗です。
FilesTotal	integer	ソースストレージでスキャンされたファイルの数です。	3
FilesDone	integer	データがフローされた (スキップされたファイルを含む) ファイルの数です。	3
ActualFiles	integer	データが実際にフローされたファイルの数です。	3
BytesTotal	integer	ソースストレージでスキャンされたデータ量です。単位：バイト。	131092971520
BytesDone	integer	フローされた (スキップされたデータを含む) データ量です。単位：バイト。	131092971520
ActualBytes	integer	実際にフローされたデータ量です。単位：バイト。	131092971520
RemainTime	integer	推定残り時間です。単位：秒。	437
AverageSpeed	integer	平均フロー速度です。単位：Byte/s。	342279299
Reports	object
Report	array<object>	レポートのリストです。説明ストリーミングタスクはレポートをサポートしていません。 WithReport が True に設定されている場合、このパラメーターは CPFS AI-Computing Edition のレポートデータを返します。 WithReport パラメーターは CPFS AI-Computing Edition でのみサポートしています。
	object
Name	string	レポートの名前です。 CPFS： TotalFilesReport：タスクレポート。 CPFS AI-Computing Edition： FailedFilesReport：失敗したファイルのレポート。 SkippedFilesReport：スキップされたファイルのレポート。 SuccessFilesReport：成功したファイルのレポート。	TotalFilesReport
Path	string	レポートへのリンクです。	https://a-hbr-temp-cn-hangzhou-staging.oss-cn-hangzhou.aliyuncs.com/temp/report/162319438359**/job-000bb6fwqficjbxk/job-000bb6fwqficjbxk_failed.zip?Expires=1721201422&OSSAccessKeyId=LTA**************&Signature=Fp%2BvauORTIVxooXY2tec6z0T%2Bp4%3D
Includes	string	ディレクトリ配下のサブディレクトリをフィルタリングし、このフィルターに含まれるフォルダーのみを転送します。説明この機能は CPFS AI-Computing Edition でのみサポートしています。	["/test/","/test1/"]
TransferFileListPath	string	転送対象のファイルリスト (CSV形式) が格納されている CPFS ファイルシステム上のパスを指定します。説明この機能は CPFS AI-Computing Edition でのみサポートしています。	/path_in_cpfs/

例

成功レスポンス

JSONJSON

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "TaskInfo": {
    "Task": [
      {
        "FilesystemId": "bmcpfs-290w65p03ok64ya****",
        "DataFlowId": "df-194433a5be31****",
        "TaskId": "task-38aa8e890f45****",
        "SourceStorage": "oss://178321033379****:bucket-01",
        "FileSystemPath": "/a/b/c/",
        "Originator": "User",
        "TaskAction": "Import",
        "DataType": "MetaAndData ",
        "Progress": 50,
        "Status": "Failed",
        "ReportPath": "/path_in_cpfs/reportfile.cvs",
        "CreateTime": "2021-08-04 18:27:35",
        "StartTime": "2021-08-04 18:27:35",
        "EndTime": "2021-08-04 18:27:35",
        "FsPath": "/aa/",
        "ConflictPolicy": "KEEP_LATEST",
        "Directory": "/path_in_cpfs/",
        "DstDirectory": "/path_in_cpfs/\n",
        "ErrorMsg": "{\"ErrorKey\":\"PATH_NOT_ACCESSIBLE\",\"ErrorDetail\":\"lstat /cpfs/370lx1ev9ss27o****/test/abcdfnotfound: no such file or directory\"}",
        "ProgressStats": {
          "FilesTotal": 3,
          "FilesDone": 3,
          "ActualFiles": 3,
          "BytesTotal": 131092971520,
          "BytesDone": 131092971520,
          "ActualBytes": 131092971520,
          "RemainTime": 437,
          "AverageSpeed": 342279299
        },
        "Reports": {
          "Report": [
            {
              "Name": "TotalFilesReport",
              "Path": "https://a-hbr-temp-cn-hangzhou-staging.oss-cn-hangzhou.aliyuncs.com/temp/report/162319438359****/job-000bb6fwqficjbxk****/job-000bb6fwqficjbxk****_failed.zip?Expires=1721201422&OSSAccessKeyId=LTA****************&Signature=Fp%2BvauORTIVxooXY2tec6z0T%2Bp4%3D"
            }
          ]
        },
        "Includes": "[\"/test/\",\"/test1/\"]\n",
        "TransferFileListPath": "/path_in_cpfs/\n"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalCharacters	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	InvalidFilesystemVersion.NotSupport	This Api does not support this fileSystem version.
403	OperationDenied.DataFlowNotSupported	The operation is not supported.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.
404	InvalidFileSystem.NotFound	The specified file system does not exist.
404	InvalidDataFlow.NotFound	The specified data flow does not exist.
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.
404	InvalidFilterParam	The specified Filter.N.Key is invalid.

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

変更履歴

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