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

Cloud Parallel File Storage:DescribeDataFlowTasks

最終更新日:Jul 31, 2026

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

操作説明

データフロータスクのクエリは、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。

bmcpfs-290w65p03ok64ya****

Filters

array<object>

任意

フィルター条件。

object

任意

Key

string

任意

フィルターキーの名前。

列挙値:

  • Status :

    データフローのステータスでフィルターします。

  • TaskIds :

    データフロータスク ID でフィルターします。

  • Originator :

    データフロータスクの開始元でフィルターします。

  • CreateTimeEnd :

    指定された時間より前に作成されたデータフロータスクをフィルターします。

  • EndTimeBegin :

    指定された時間以降に終了したデータフロータスクをフィルターします。

  • DataFlowIds :

    データフロー ID でフィルターします。

  • StartTimeEnd :

    指定された時間より前に開始されたデータフロータスクをフィルターします。

  • TaskActions :

    データフロータスクのタイプでフィルターします。

  • EndTimeEnd :

    指定された時間より前に終了したデータフロータスクをフィルターします。

  • StartTimeBegin :

    指定された時間以降に開始されたデータフロータスクをフィルターします。

  • CreateTimeBegin :

    指定された時間以降に作成されたデータフロータスクをフィルターします。

  • DataTypes :

    データフロータスクのデータの型でフィルターします。

DataFlowIds

Value

string

任意

フィルターキーの値。ワイルドカードはサポートされていません。

df-194433a5be31****

NextToken

string

任意

次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。返された結果が切り捨てられている場合、NextToken を使用して新しいリクエストを開始し、切り捨てポイント以降の内容を取得できます。

TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=

MaxResults

integer

任意

各クエリの結果の数。

20

WithReports

boolean

任意

レポート情報をクエリするかどうかを指定します。

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>。

oss://178321033379****:bucket-01

FileSystemPath

string

CPFS ファイルシステム内の fileset のパス。

/a/b/c/

Originator

string

データフロータスクの開始元。有効な値:

User

TaskAction

string

データフローノードのタイプ。有効な値:

Import

DataType

string

データフロータスクのデータの型。有効な値:

MetaAndData

Progress

integer

データフロータスクの進捗状況。現在のデータフロータスクによって実行された操作の数。

50

Status

string

データフロータスクのステータス。有効な値:

Failed

ReportPath deprecated

string

CPFS ファイルシステム内でデータフロータスクのレポートが保存されているパス。

/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

ファイル名の競合ポリシー。

列挙値:

  • 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>

レポートのリスト。

object

Name

string

レポート名。

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

指定されたディレクトリ配下のディレクトリをフィルターし、フィルターされたフォルダーのコンテンツを転送します。

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

TransferFileListPath

string

OSS ディレクトリを指定し、その OSS ディレクトリ内の CSV ファイルのコンテンツに基づいてデータを同期します。

/path_in_cpfs/

EntryList

string

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

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

例

成功レスポンス

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": "[\"/path_in_cpfs/file1\", \"/path_in_cpfs/file2\"]"
      }
    ]
  }
}

エラーコード

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 パラメーターが無効です。

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

変更履歴

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