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

データフローバッチサブタスクを照会します。

操作説明

この操作は、CPFS for Lingjun 2.6.0 以降でのみサポートされています。バージョン情報は、コンソールのファイルシステム詳細ページで確認できます。

開始前に

この操作を呼び出してデータフローサブタスクを照会する前に、次の順序でリソースの作成とタスクの起動を完了してください。

bmcpfs ファイルシステムの作成: コンソールで CPFS for Lingjun ファイルシステムを作成し、ステータスが Running に変わるまで待機します。
データフローの作成: CreateDataFlow を呼び出して、ファイルシステム上にデータフローチャンネルを作成します。
データフロータスクの起動: CreateDataFlowTask を呼び出して、データフロータスクを作成および起動します。タスクのステータスは Running である必要があります。
サブタスクの照会: サブタスクは、データフロータスクの実行中に自動的に生成されます。DescribeDataFlowSubTasks 操作を呼び出して、これらのサブタスクのリストを照会します。

今すぐお試しください

この 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: 送信先ファイルパスでフィルター処理します。列挙値: Status : データフローのステータスでフィルター処理します。 DstFilePath : 送信先ファイルパスでフィルター処理します。 DataFlowSubTaskIds : データフローストリーミングタスク ID でフィルター処理します。 SrcFilePath : ソースファイルパスでフィルター処理します。 DataFlowIds : データフロー ID でフィルター処理します。 DataFlowTaskIds : データフロータスク ID でフィルター処理します。	DataFlowSubTaskIds
Value	string	任意	フィルターキーの値。ワイルドカードはサポートされていません。 Key が DataFlowIds に設定されている場合、Value にはデータフロー ID またはデータフロー ID の一部を指定します。1 つ以上のデータフロー ID を指定できます。最大 10 個のデータフロー ID を指定できます。例: df-194433a5be31** または df-194433a512a2,df-234533a5be31。 Key が DataFlowTaskIds に設定されている場合、Value にはデータフロータスク ID またはデータフロータスク ID の一部を指定します。1 つ以上のデータフロータスク ID を指定できます。最大 10 個のデータフロータスク ID を指定できます。例: task-29ee8e890f45 または task-29ee8e890f45,task-38ae8e890f45。 Key が DataFlowSubTaskIds に設定されている場合、Value にはデータフローストリーミングタスク ID またはデータフローストリーミングタスク ID の一部を指定します。1 つ以上のデータフローストリーミングタスク 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。	タスク-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	ストリーミングタスクが作成された時間。時間は ISO 8601 規格に従い、yyyy-MM-dd HH:mm:ss フォーマットです。	2024-07-01 19:59:29
StartTime	string	ストリーミングタスクが開始された時間。時間は ISO 8601 規格に従い、yyyy-MM-dd HH:mm:ss フォーマットです。	2024-07-03 10:43:16
EndTime	string	ストリーミングタスクが終了した時間。時間は ISO 8601 規格に従い、yyyy-MM-dd HH:mm:ss フォーマットです。	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****",
        "DataFlowId": "df-194433a5be31****\n",
        "DataFlowTaskId": "task-38aa8e890f45****",
        "DataFlowSubTaskId": "subTaskId-370kyfmyknxcyzw****",
        "SrcFilePath": "/test/file.png。",
        "DstFilePath": "/mnt/file.png。",
        "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.	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 パラメーターが無効です。

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

変更履歴

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