本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
ListSearchJobs
此操作會傳回屬於 帳戶的搜尋任務清單。
請求語法
GET /search-jobs?MaxResults=MaxResults
&NextToken=NextToken
&Status=ByStatus
HTTP/1.1
URI 請求參數
請求會使用下列 URI 參數。
- ByStatus
-
包含此參數,依搜尋任務狀態篩選清單。
有效值:
RUNNING | COMPLETED | STOPPING | STOPPED | FAILED
- MaxResults
-
要傳回的資源清單項目最大數量。
有效範圍:最小值為 1。最大值為 1000。
- NextToken
-
傳回之搜尋任務的部分清單之後的下一個項目。
例如,如果請求傳回備份
MaxResults
數量,NextToken
可讓您從下一個字符指向的位置開始傳回清單中的更多項目。
請求主體
請求沒有請求主體。
回應語法
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"SearchJobs": [
{
"CompletionTime": number,
"CreationTime": number,
"Name": "string",
"SearchJobArn": "string",
"SearchJobIdentifier": "string",
"SearchScopeSummary": {
"TotalItemsToScanCount": number,
"TotalRecoveryPointsToScanCount": number
},
"Status": "string",
"StatusMessage": "string"
}
]
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- NextToken
-
搜尋任務中包含之已傳回備份的部分清單後的下一個項目。
例如,如果請求傳回備份
MaxResults
數量,NextToken
可讓您從下一個字符指向的位置開始傳回清單中的更多項目。類型:字串
- SearchJobs
-
清單中的搜尋任務,其中包含傳回搜尋任務的詳細資訊。
類型:SearchJobSummary 物件陣列
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- AccessDeniedException
-
您沒有足夠存取權可執行此動作。
HTTP 狀態碼:403
- InternalServerException
-
發生內部伺服器錯誤。重試您的請求。
HTTP 狀態碼:500
- ThrottlingException
-
由於請求調節,因此請求遭到拒絕。
HTTP 狀態碼:429
- ValidationException
-
輸入無法滿足服務指定的限制條件。
HTTP 狀態碼:400
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: