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

データフローサブタスクをバッチでクエリします。

操作説明

CPFS インテリジェントコンピューティング版 2.6.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:DescribeDataFlowSubTasks

list

*DataFlow

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FileSystemId	string	必須	ファイルシステムの ID。	bmcpfs-370lx1ev9ss27o0****
Filters	array<object>	任意	データストリーミングタスクのクエリに使用するフィルターです。
	object	任意
Key	string	任意	フィルター名。有効な値： DataFlowIds：データフロー ID に基づいてデータフローサブタスクをフィルターします。 DataFlowTaskIds：データフロータスク ID に基づいてデータフローサブタスクをフィルターします。 DataFlowSubTaskIds：データフローサブタスク ID に基づいてデータフローサブタスクをフィルターします。 Status：ステータスに基づいてデータフローサブタスクをフィルターします。 SrcFilePath：ソースファイルパスに基づいてデータフローサブタスクをフィルターします。 DstFilePath：宛先ファイルパスに基づいてデータフローサブタスクをフィルターします。	DataFlowSubTaskIds
Value	string	任意	フィルター値。このパラメーターはワイルドカードをサポートしていません。 Key が DataFlowIds に設定されている場合、Value をデータフロー ID またはデータフロー ID の一部に設定します。データフロー ID またはデータフロー ID のグループを指定できます。最大 10 個のデータフロー ID を指定できます。例：`df-194433a5be31**` または `df-194433a512a2,df-234533a5be31`。 Key が DataFlowTaskIds に設定されている場合、Value をデータフロータスク ID またはデータフロータスク ID の一部に設定します。データフロータスク ID またはデータフロータスク ID のグループを指定できます。最大 10 個のデータフロータスク ID を指定できます。例：`task-29ee8e890f45` または `task-29ee8e890f45,task-38ae8e890f45`。 Key が DataFlowSubTaskIds に設定されている場合、Value をデータフローサブタスク ID またはデータフローサブタスク ID の一部に設定します。データフローサブタスク ID またはデータフローサブタスク ID のグループを指定できます。最大 10 個のデータフローサブタスク ID を指定できます。例：`subTaskId-370kyfmyknxcyzw` または `subTaskId-247kyfmyknxcyzw,subTaskId-256kyfmyknxcyzw**`。 Key が Status に設定されている場合、Value をデータフロータスクのステータスに設定します。ステータスは、EXPIRED、CREATED、RUNNING、COMPLETE、CANCELING、FAILED、または CANCELED です。複合クエリがサポートされています。 Key が SrcFilePath に設定されている場合、Value をソースファイルのパスに設定します。パスの長さは最大 1,023 文字です。 Key が DstFilePath に設定されている場合、Value を宛先ファイルのパスに設定します。パスの長さは最大 1,023 文字です。	subTaskId-370kyfmyknxcyzw****
NextToken	string	任意	次のリクエストで使用されるページネーショントークンで、結果の新しいページを取得します。最初のリクエストではこのパラメーターを指定する必要はありません。前のクエリから取得したトークンを NextToken の値として指定する必要があります。	iWk0AQAAAAAvY2FzZS8=
MaxResults	integer	任意	各クエリの結果数。有効な値：20～100。デフォルト値：20。	20

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	98696EF0-1607-4E9D-B01D-F20930B6****
NextToken	string	次のリクエストで使用されるページネーショントークンで、結果の新しいページを取得します。最初のリクエストではこのパラメーターを指定する必要はありません。前のクエリから取得したトークンを NextToken の値として指定する必要があります。	pUJaUwAAAABhdGUyNTk1MQ==
DataFlowSubTask	object
DataFlowSubTask	array<object>	データフローサブタスクに関する詳細。
	array<object>
FileSystemId	string	ファイルシステムの ID。	bmcpfs-370lx1ev9ss27o0****
DataFlowId	string	データフローの ID。	df-194433a5be31****
DataFlowTaskId	string	データフロータスクの ID。	task-38aa8e890f45****
DataFlowSubTaskId	string	データフローサブタスクの ID。	subTaskId-370kyfmyknxcyzw****
SrcFilePath	string	ソースファイルのパス。制限事項：パスの長さは 1～1,023 文字である必要があります。パスは UTF-8 でエンコードされている必要があります。パスはスラッシュ (/) で始まる必要があります。パスはファイル名で終わる必要があります。	/test/file.png
DstFilePath	string	宛先ファイルのパス。制限事項：パスの長さは 1～1,023 文字である必要があります。パスは UTF-8 でエンコードされている必要があります。パスはスラッシュ (/) で始まる必要があります。パスはファイル名で終わる必要があります。	/mnt/file.png
Status	string	データフローサブタスクのステータス。次の情報が表示されます： EXPIRED：タスクは終了しました。 CREATED：タスクは作成されました。 RUNNING：タスクは実行中です。 COMPLETE：タスクは完了しました。 CANCELING：タスクはキャンセル中です。 FAILED：タスクの実行に失敗しました。 CANCELED：タスクはキャンセルされました。	FAILED
Progress	integer	データフローサブタスクの進捗。有効な値：0～10000。	10000
CreateTime	string	データフローサブタスクが作成された時間。	2024-07-01 19:59:29
StartTime	string	データフローサブタスクが開始された時間。	2024-07-03 10:43:16
EndTime	string	データフローサブタスクが終了した時間。	2024-07-04 11:14:22
ErrorMsg	string	タスクが失敗した場合に返されるエラーメッセージ。説明このパラメーターが返されないか、戻り値が空の場合、エラーは発生していません。	file does not exist
ProgressStats	object	データフローサブタスクに関する進捗情報。
BytesTotal	integer	ソースでスキャンされたデータ量。単位：バイト。	68
BytesDone	integer	データフロータスクが完了したデータ量 (スキップされたデータを含む)。単位：バイト。	68
ActualBytes	integer	データフロータスクが完了した実際のデータ量。単位：バイト。	68
AverageSpeed	integer	平均フロー速度。単位：バイト/秒。	34
FileDetail	object	ファイルに関する情報。
ModifyTime	integer	ファイルが変更された時間。値は UNIX タイムスタンプです。単位：ns。	1725897600000000000
Size	integer	ファイルサイズ。単位：バイト。	68
Checksum	string	チェックサム。フォーマット例：crc64:123456。	crc64:850309505450944****

例

成功レスポンス

JSONJSON

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "NextToken": "pUJaUwAAAABhdGUyNTk1MQ==",
  "DataFlowSubTask": {
    "DataFlowSubTask": [
      {
        "FileSystemId": "bmcpfs-370lx1ev9ss27o0****\n",
        "DataFlowId": "df-194433a5be31****\n",
        "DataFlowTaskId": "task-38aa8e890f45****",
        "DataFlowSubTaskId": "subTaskId-370kyfmyknxcyzw****\n",
        "SrcFilePath": "/test/file.png\n",
        "DstFilePath": "/mnt/file.png\n",
        "Status": "FAILED",
        "Progress": 10000,
        "CreateTime": "2024-07-01 19:59:29",
        "StartTime": "2024-07-03 10:43:16",
        "EndTime": "2024-07-04 11:14:22",
        "ErrorMsg": "file does not exist",
        "ProgressStats": {
          "BytesTotal": 68,
          "BytesDone": 68,
          "ActualBytes": 68,
          "AverageSpeed": 34
        },
        "FileDetail": {
          "ModifyTime": 1725897600000000000,
          "Size": 68,
          "Checksum": "crc64:850309505450944****"
        }
      }
    ]
  }
}

エラーコード

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.

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

変更履歴

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