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

データフロータスクの詳細を照会します。

操作説明

データフロータスクのクエリは、CPFS 2.2.0 以降および CPFS for Lingjun 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: `cpfs-` で始まる必要があります (例: cpfs-099394bd928c**)。 CPFS for Lingjun: `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: 指定した時間より前に終了したデータフロータスクをフィルターします。列挙値: Status : データフローのステータスでフィルターします。 TaskIds : データフロータスク ID でフィルターします。 Originator : データフロータスクの開始元でフィルターします。 CreateTimeEnd : 指定した時間より前に作成されたデータフロータスクをフィルターします。 EndTimeBegin : 指定した時間以降に終了したデータフロータスクをフィルターします。 DataFlowIds : データフロー ID でフィルターします。 StartTimeEnd : 指定した時間より前に開始されたデータフロータスクをフィルターします。 TaskActions : データフロータスクのタイプでフィルターします。 EndTimeEnd : 指定した時間より前に終了したデータフロータスクをフィルターします。 StartTimeBegin : 指定した時間以降に開始されたデータフロータスクをフィルターします。 CreateTimeBegin : 指定した時間以降に作成されたデータフロータスクをフィルターします。 DataTypes : データフロータスクのデータの型でフィルターします。	DataFlowIds。
Value	string	任意	フィルターキーの値。ワイルドカードはサポートされていません。 Key が DataFlowIds にセットされている場合、Value はデータフロー ID またはデータフロー ID の一部にセットされます。1 つ以上のデータフロー ID を指定できます。最大 10 個のデータフロー ID を指定できます。例: `df-194433a5be31**` または `df-194433a512a2,df-234533a5be31`。 Key が TaskId にセットされている場合、Value はデータフロータスク ID またはデータフロータスク ID の一部にセットされます。1 つ以上のデータフロータスク ID を指定できます。最大 10 個のデータフロータスク ID を指定できます。例: `task-38aa8e890f45` または `task-38aa8e890f45,task-29ae8e890f45`。 Key が TaskActions にセットされている場合、Value はデータフロータスクのタイプにセットされ、Import、Export、Evict、Inventory、StreamImport、StreamExport** が含まれます。組み合わせたクエリがサポートされています。CPFS for Lingjun では、Import、Export、StreamImport、StreamExport のみがサポートされています。StreamImport と StreamExport は、CPFS for Lingjun 2.6.0 以降でのみサポートされています。 Key が DataTypes にセットされている場合、Value はデータフロータスクのデータの型にセットされ、MetaAndData、Metadata、Data が含まれます。組み合わせたクエリがサポートされています。 Key が Originator にセットされている場合、Value はデータフロータスクの開始元にセットされ、User および System が含まれます。 Key が Status にセットされている場合、Value はデータフロータスクのステータスにセットされ、Pending、Executing、Failed、Completed、Canceling、Canceled が含まれます。組み合わせたクエリがサポートされています。 Key が CreateTimeBegin にセットされている場合、Value はデータフロータスクの最も早い作成時間にセットされます。フォーマット: `yyyy-MM-ddThh:mmZ`。 Key が CreateTimeEnd にセットされている場合、Value はデータフロータスクの最も遅い作成時間にセットされます。フォーマット: `yyyy-MM-ddThh:mmZ`。 Key が StartTimeBegin にセットされている場合、Value はデータフロータスクの最も早い開始時刻にセットされます。フォーマット: `yyyy-MM-ddThh:mmZ`。 Key が StartTimeEnd にセットされている場合、Value はデータフロータスクの最も遅い開始時刻にセットされます。フォーマット: `yyyy-MM-ddThh:mmZ`。 Key が EndTimeBegin にセットされている場合、Value はデータフロータスクの最も早い終了時間にセットされます。フォーマット: `yyyy-MM-ddThh:mmZ`。 Key が EndTimeEnd にセットされている場合、Value はデータフロータスクの最も遅い終了時間にセットされます。フォーマット: `yyyy-MM-ddThh:mmZ`。	df-194433a5be31****
NextToken	string	任意	次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。返された結果が切り捨てられている場合、NextToken を使用して新しいリクエストを開始し、現在の切り捨て位置以降の内容を取得できます。	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	integer	任意	各クエリの結果の数。有効な値: 10 ～ 100。デフォルト値: 20。	20
WithReports	boolean	任意	レポート情報をクエリするかどうかを指定します。 True (デフォルト): レポートをクエリします。 False: レポートをクエリしません。説明このパラメーターを False に設定すると、クエリを高速化できます。 CPFS for Lingjun のみがサポートされています。	True。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	2D69A58F-345C-4FDE-88E4-BF518948****
NextToken	string	次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。返された結果が切り捨てられている場合、NextToken を使用して新しいリクエストを開始し、現在の切り捨て位置以降の内容を取得できます。	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 for Lingjun 2.6.0 以降でのみサポートされています。	oss://178321033379****:bucket-01
FileSystemPath	string	CPFS ファイルシステム内の fileset のパス。使用制限: 長さは 2 〜 1,024 文字です。 UTF-8 エンコーディングが使用されます。パスはスラッシュ (/) で始まり、スラッシュ (/) で終わる必要があります。ディレクトリは CPFS 上の fileset ディレクトリである必要があります。説明このパラメーターは CPFS のみがサポートしています。	/a/b/c/
Originator	string	データフロータスクの開始者。有効な値: User: タスクはユーザーによって開始されました。 System: タスクは自動更新間隔に基づいて CPFS によって開始された自動更新タスクです。説明このパラメーターは CPFS のみがサポートしています。	User。
TaskAction	string	データフローノードのタイプ。有効な値: Import: ソースストレージから CPFS へ指定されたデータのデータインポートを実行します。 Export: CPFS からソースストレージへ指定されたデータをエクスポートします。 StreamImport: データストリームノードとして、ソースストレージから CPFS へ指定されたデータのデータインポートを実行します。 StreamExport: データストリームノードとして、CPFS からソースストレージへ指定されたデータをエクスポートします。 Evict: CPFS 上のファイルのデータブロックをリリースします。リリース後、CPFS にはメタデータのみが保持されます。ファイルのクエリは引き続き可能ですが、データブロックは削除され、CPFS 上のストレージ容量を占有しません。ファイルデータにアクセスすると、必要に応じてソースストレージからロードされます。 Inventory: CPFS 上でデータフローによって管理されるファイルのチェックリストを取得します。これにより、データフロー内のファイルのキャッシュステータスが提供されます。説明 StreamImport と StreamExport は CPFS for Lingjun 2.6.0 以降でのみサポートされています。	Import。
DataType	string	データフロータスクのデータの型。有効な値: Metadata: タイムスタンプ、所有権、権限、その他の属性を含むファイルのメタデータ。Metadata が選択されている場合、ファイルのメタデータのみがインポートされます。ユーザーはファイルを確認できますが、ファイルデータにアクセスすると、データは必要に応じてソースストレージからロードされます。 Data: ファイルのデータブロック。 MetaAndData: ファイルのメタデータとデータブロック。説明 CPFS for Lingjun は MetaAndData タイプのみをサポートしています。	MetaAndData。
Progress	integer	データフロータスクの進捗状況。現在のデータフロータスクによって実行された操作の数。	50
Status	string	データフロータスクのステータス。有効な値: Pending: データフロータスクは作成されてキューに入れられましたが、まだ開始されていません。 Executing: データフロータスクが実行中です。 Failed: データフロータスクが失敗しました。失敗した理由はデータフロータスクレポートで確認できます。 Completed: データフロータスクが完了しました。すべてのファイルが正しく転送されたことを確認するには、データフロータスクレポートを確認します。 Canceled: データフロータスクがキャンセルされ、完了しませんでした。 Canceling: データフロータスクがキャンセル中です。	Failed。
ReportPath `deprecated`	string	CPFS ファイルシステム内でデータフロータスクレポートが保存されているパス。 CPFS の場合、タスクレポートは CPFS ファイルシステムの `.dataflow_report` ディレクトリに生成されます。 CPFS for Lingjun の場合、OSS ダウンロードリンクが返されます。このリンクを使用してタスクレポートをダウンロードできます。	/path_in_cpfs/reportfile.cvs
CreateTime	string	タスクが作成された時間。時間は ISO 8601 標準に従います。フォーマット: yyyy-MM-dd HH:mm:ss。	2021-08-04 18:27:35
StartTime	string	タスクが開始された時刻。時間は ISO 8601 標準に従います。フォーマット: yyyy-MM-dd HH:mm:ss。	2021-08-04 18:27:35
EndTime	string	タスクが終了した時間。時間は ISO 8601 標準に従います。フォーマット: yyyy-MM-dd HH:mm:ss。	2021-08-04 18:27:35
FsPath	string	インテリジェントディレクトリパス。	/aa/
ConflictPolicy	string	同名ファイルの競合ポリシー。 SKIP_THE_FILE: 同名のファイルをスキップします。 KEEP_LATEST: 更新時間を比較し、最新バージョンを保持します。 OVERWRITE_EXISTING: 同名のファイルを強制的に上書きします。列挙値: KEEP_LATEST : 更新時間を比較し、最新バージョンを保持します。 OVERWRITE_EXISTING : 同名のファイルを強制的に上書きします。 SKIP_THE_FILE : 同名のファイルをスキップします。	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	平均転送速度。単位: バイト/秒。	342279299
Reports	object
Report	array<object>	レポートリスト。説明ストリーミングタスクはレポートをサポートしていません。 WithReport が True に設定されている場合、このパラメーターは CPFS for Lingjun のレポートデータを返します。 WithReport パラメーターは CPFS for Lingjun のみがサポートしています。
	object
Name	string	レポート名。 CPFS: TotalFilesReport: タスクレポート。 CPFS for Lingjun: 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 for Lingjun のみがサポートしています。	["/test/","/test1/"]
TransferFileListPath	string	指定された OSS ディレクトリ。OSS ディレクトリ内の CSV ファイルの内容に基づいてデータが同期されます。説明この特徴は CPFS for Lingjun のみがサポートしています。	/path_in_cpfs/
EntryList	string

例

成功レスポンス

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/",
        "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/\"]",
        "TransferFileListPath": "/path_in_cpfs/",
        "EntryList": ""
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	IllegalCharacters	The parameter contains illegal characters.	指定されたパラメーターが無効です。
400	MissingFileSystemId	FileSystemId is mandatory for this action.	FileSystemId パラメーターが指定されていません。
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.	指定された MaxResults が無効です。
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	指定された Filter.N.Key パラメーターが無効です。

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

変更履歴

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