ListLifecycleRetrieveJobs - File Storage NAS - Alibaba Cloud ドキュメントセンター

作成済みのデータ取得タスクのリストを取得します。

操作説明

この特徴は、汎用 NAS ファイルシステムのみでサポートされています。

今すぐお試しください

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

get

*FileSystem

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageSize	integer	任意	各ページのデータ取得タスクの数。有効な値: 1～100。デフォルト値: 10。	10
PageNumber	integer	任意	リストのページ番号。開始値 (デフォルト値): 1。	1
FileSystemId	string	任意	ファイルシステムの ID。	31a8e4****
Status	string	任意	データ取得タスクのステータス。有効な値: active: アクティブな。 canceled: キャンセル済み。 completed: 完了。 failed: 失敗した。列挙値: canceled : キャンセル済み。 active : 実行中。 completed : 完了。 failed : 失敗。	completed
StorageType	string	任意	ストレージクラス。有効な値: InfrequentAccess: IA ストレージクラス。 Archive: アーカイブストレージクラス。説明 StorageType が指定されていない場合、すべてのストレージクラスのデータ取得タスクが返されます。	InfrequentAccess

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	データ取得タスクの総数。	10
RequestId	string	リクエスト ID。	BC7C825C-5F65-4B56-BEF6-98C56C7C****
PageSize	integer	各ページのデータ取得タスクの数。	10
PageNumber	integer	リストのページ番号。	1
LifecycleRetrieveJobs	array<object>	データ取得タスク情報のコレクション。
	object	データ取得タスク情報のコレクション。
FileSystemId	string	ファイルシステムの ID。	31a8e4****
Status	string	データ取得タスクのステータス。有効な値: active: アクティブな。 canceled: キャンセル済み。 completed: 完了。 failed: 失敗した。	completed
DiscoveredFileCount	integer	データ取得タスクによって読み取りされたファイルの総数。	100
UpdateTime	string	タスクが最後に更新された時間。時間は ISO 8601 標準に従い、`yyyy-MM-ddTHH:mm:ssZ` のフォーマットです。	2021-02-30T11:08:08Z
Paths	array	データ取得タスクの実行パス。
	string	取得するディレクトリまたはファイル。パスは転送スラッシュ (/) で始まる必要があり、マウントポイントに存在するパスである必要があります。	["/パス/to/folder","/パス/to/folder","/パス/to/folder"]
RetrievedFileCount	integer	データ取得タスクによって正常に取得されたファイルの数。	80
JobId	string	データ取得タスクの ID。	lrj-nfstest-ia-160****853-hshvw
CreateTime	string	タスクが作成された時間。時間は ISO 8601 標準に従い、`yyyy-MM-ddTHH:mm:ssZ` のフォーマットです。	2021-02-30T10:08:08Z
StorageType	string	ストレージクラス。有効な値: InfrequentAccess: IA ストレージクラス。 Archive: アーカイブストレージクラス。	InfrequentAccess

例

成功レスポンス

JSONJSON

{
  "TotalCount": 10,
  "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
  "PageSize": 10,
  "PageNumber": 1,
  "LifecycleRetrieveJobs": [
    {
      "FileSystemId": "31a8e4****",
      "Status": "completed",
      "DiscoveredFileCount": 100,
      "UpdateTime": "2021-02-30T11:08:08Z",
      "Paths": [
        "[\"/pathway/to/folder\",\"/pathway/to/folder\",\"/pathway/to/folder\"]"
      ],
      "RetrievedFileCount": 80,
      "JobId": "lrj-nfstest-ia-160****853-hshvw",
      "CreateTime": "2021-02-30T10:08:08Z",
      "StorageType": "InfrequentAccess"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidFileSystem.NotFound	The specified file system does not exist.	指定されたファイルシステムが存在しません。

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

変更履歴

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