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

ゴミ箱のジョブを照会します。

操作説明

この操作は、汎用型 NAS ファイルシステムのみでサポートされています。
最近実行されたジョブを最大 50 件まで照会できます。

今すぐお試しください

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

get

*FileSystem

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FileSystemId	string	必須	ファイルシステムの ID です。	1ca404****
JobId	string	任意	ジョブ ID です。	rb-15**ed-r-1625**2441
PageSize	integer	任意	1 ページあたりのエントリ数です。有効値：1～100。デフォルト値：10。	10
PageNumber	integer	任意	ページ番号です。ページは 1 から始まります。デフォルト値：1。	1
Status	string	任意	ジョブのステータスです。有効な値： Running：ジョブは実行中です。 Defragmenting：ジョブはデータをデフラグ中です。 PartialSuccess：ジョブは部分的に成功しました。 Success：ジョブは成功しました。 Fail：ジョブは失敗しました。 Cancelled：ジョブはキャンセルされました。 all (デフォルト)	All

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID です。	9E15E394-38A6-457A-A62A-D9797C9A****
TotalCount	integer	ジョブの総数です。	1
PageNumber	integer	ページ番号です。	1
PageSize	integer	1 ページあたりに返されるジョブの数です。	10
Jobs	array<object>	ゴミ箱のジョブに関する情報です。
	object
Id	string	ジョブ ID です。	8C****C54
Type	string	ジョブのタイプです。有効な値： Restore：ファイル復元ジョブ Delete：ファイル削除ジョブ	Restore
FileId	string	ジョブ内のファイルまたはディレクトリの ID です。	04***08
Status	string	ジョブのステータスです。有効な値： Running：ジョブは実行中です。 Defragmenting：ジョブはデータをデフラグ中です。 PartialSuccess：ジョブは部分的に成功しました。 Success：ジョブは成功しました。 Fail：ジョブは失敗しました。 Cancelled：ジョブはキャンセルされました。	Fail
ErrorCode	string	返されたエラーコードです。 Status パラメーターを Fail または PartialSuccess に設定した場合にのみ、有効な値が返されます。	InvalidFileId.NotFound
Progress	string	ジョブの進捗です。有効値：1～100。	100
CreateTime	string	ジョブが作成された時刻です。	2021-05-30T10:08:08Z
FileName	string	ジョブに関連付けられているファイルまたはディレクトリの名前です。	test001
ErrorMessage	string	エラーメッセージです。 Status パラメーターを Fail または PartialSuccess に設定した場合にのみ、有効な値が返されます。	The Target File or Directory does not exist.

例

成功レスポンス

JSONJSON

{
  "RequestId": "9E15E394-38A6-457A-A62A-D9797C9A****",
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "Jobs": [
    {
      "Id": "8C****C54",
      "Type": "Restore",
      "FileId": "04***08",
      "Status": "Fail",
      "ErrorCode": "InvalidFileId.NotFound",
      "Progress": "100",
      "CreateTime": "2021-05-30T10:08:08Z",
      "FileName": "test001",
      "ErrorMessage": "The Target File or Directory does not exist."
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalCharacters	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	InvalidStatus	Specified parameter Status is not valid.
404	InvalidFileSystem.NotFound	The specified file system does not exist.
404	InvalidJobId.NotFound	The specified JobId(%JobId) does not exist.

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

変更履歴

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