ListRecycleBinJobs - 查詢資源回收筒中的工作清單 - File Storage NAS

查詢資源回收筒中的一個或多個任務資訊。

介面說明

僅通用型 NAS 檔案系統支援該功能。
最多可以查詢最近執行的 50 個任務。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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~100 預設值：10	10
PageNumber	integer	否	分頁查詢時當前的頁碼。起始值（預設值）：1	1
Status	string	否	任務狀態。取值： Running：運行中 Defragmenting：資料整理中 PartialSuccess：部分運行成功 Success：運行成功 Fail：運行失敗 Cancelled：已取消 All（預設值）：全部	All

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	9E15E394-38A6-457A-A62A-D9797C9A****
TotalCount	integer	資源回收筒中任務的總個數。	1
PageNumber	integer	列表的分頁頁碼。	1
PageSize	integer	每個分頁包含的任務個數。	10
Jobs	array<object>	資源回收筒中的任務資訊集合。
	object
Id	string	任務 ID。	8C****C54
Type	string	任務類型。包括： Restore：檔案恢複任務 Delete：檔案刪除任務	Restore
FileId	string	任務對應檔案或目錄的 FileId。	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	錯誤資訊。當 JobStatus 為 Fail 或 PartialSuccess 時，該傳回值有效。	The Target File or Directory does not exist.

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
400	IllegalCharacters	The parameter contains illegal characters.	參數非法。
400	MissingFileSystemId	FileSystemId is mandatory for this action.	未指定FileSystemId參數。
400	InvalidStatus	Specified parameter Status is not valid.	指定的Status非法。
404	InvalidFileSystem.NotFound	The specified file system does not exist.	指定的檔案系統不存在。
404	InvalidJobId.NotFound	The specified JobId(%JobId) does not exist.	指定的任務ID不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。