本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# ListBackupJobs
<a name="API_ListBackupJobs"></a>

傳回過去 30 天內已驗證帳戶的現有備份任務清單。如需更長的時間，請考慮使用這些[監視工具](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)。

## 請求語法
<a name="API_ListBackupJobs_RequestSyntax"></a>

```
GET /backup-jobs/?accountId=ByAccountId&backupVaultName=ByBackupVaultName&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1
```

## URI 請求參數
<a name="API_ListBackupJobs_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [ByAccountId](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByAccountId"></a>
列出任務的帳戶 ID。僅傳回與特定帳戶 ID 相關聯的備份任務。  
如果從 AWS Organizations 管理帳戶使用 ，傳遞會`*`傳回整個組織的所有任務。  
模式：`^[0-9]{12}$`

 ** [ByBackupVaultName](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByBackupVaultName"></a>
僅傳回將儲存在特定備份保存庫中的備份任務。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`

 ** [ByCompleteAfter](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCompleteAfter"></a>
僅傳回以 Unix 格式和國際標準時間 (UTC) 所表示日期之後完成的備份任務。

 ** [ByCompleteBefore](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCompleteBefore"></a>
僅傳回以 Unix 格式和國際標準時間 (UTC) 所表示日期之前完成的備份任務。

 ** [ByCreatedAfter](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCreatedAfter"></a>
僅傳回特定日期之後建立的備份任務。

 ** [ByCreatedBefore](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCreatedBefore"></a>
僅傳回特定日期之前建立的備份任務。

 ** [ByMessageCategory](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByMessageCategory"></a>
這是選用參數，可用於透過與您輸入之值相符的 MessageCategory 來篩選任務。  
範例字串可能包括 `AccessDenied`、`SUCCESS`、`AGGREGATE_ALL` 和 `InvalidParameters`。  
檢視[監控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)   
萬用字元 () 會傳回所有訊息類別的計數。  
 `AGGREGATE_ALL` 彙總所有訊息類別的任務計數，並傳回總和。

 ** [ByParentJobId](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByParentJobId"></a>
這是根據父系任務 ID 列出子 (巢狀) 任務的篩選器。

 ** [ByResourceArn](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByResourceArn"></a>
僅傳回符合特定資源 Amazon Resource Name (ARN) 的備份任務。

 ** [ByResourceType](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByResourceType"></a>
僅傳回指定資源的備份任務：  
+  `Aurora` 代表 Amazon Aurora
+  `CloudFormation` 適用於 的 AWS CloudFormation 
+  `DocumentDB` 代表 Amazon DocumentDB (with MongoDB compatibility)
+  `DynamoDB` 代表 Amazon DynamoDB
+  `EBS` 代表 Amazon Elastic Block Store
+  `EC2` 代表 Amazon Elastic Compute Cloud
+  `EFS` 代表 Amazon Elastic File System
+  `EKS` for Amazon Elastic Kubernetes Service
+  `FSx` 代表 Amazon FSx
+  `Neptune` 代表 Amazon Neptune
+  `RDS` 代表 Amazon Relational Database Service
+  `Redshift` 代表 Amazon Redshift
+  `S3` for Amazon Simple Storage Service (Amazon S3)
+  `SAP HANA on Amazon EC2` 適用於 Amazon Elastic Compute Cloud 執行個體上的 SAP HANA 資料庫
+  `Storage Gateway` 適用於 的 AWS Storage Gateway 
+  `Timestream` 代表 Amazon Timestream
+  `VirtualMachine` 適用於 VMware 虛擬機器
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [ByState](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByState"></a>
僅傳回處於特定狀態的備份任務。  
 `Completed with issues` 是僅在 AWS Backup 主控台中找到的狀態。對於 API，此狀態是指狀態為 `COMPLETED` 且值不是 `SUCCESS` 之 `MessageCategory` 的任務；也就是說，狀態為已完成，但出現狀態訊息。  
若要取得 `Completed with issues` 的任務計數，請執行兩個 GET 請求，並減去第二個較小的數字：  
GET /backup-jobs/?state=COMPLETED  
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED  
有效值:`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL` 

 ** [MaxResults](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListBackupJobs_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListBackupJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupJobs": [ 
      { 
         "AccountId": "string",
         "BackupJobId": "string",
         "BackupOptions": { 
            "string" : "string" 
         },
         "BackupSizeInBytes": number,
         "BackupType": "string",
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "BytesTransferred": number,
         "CompletionDate": number,
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanName": "string",
            "BackupPlanVersion": "string",
            "BackupRuleCron": "string",
            "BackupRuleId": "string",
            "BackupRuleName": "string",
            "BackupRuleTimezone": "string"
         },
         "CreationDate": number,
         "EncryptionKeyArn": "string",
         "ExpectedCompletionDate": number,
         "IamRoleArn": "string",
         "InitiationDate": number,
         "IsEncrypted": boolean,
         "IsParent": boolean,
         "MessageCategory": "string",
         "ParentJobId": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "RecoveryPointLifecycle": { 
            "DeleteAfterDays": number,
            "DeleteAfterEvent": "string",
            "MoveToColdStorageAfterDays": number,
            "OptInToArchiveForSupportedResources": boolean
         },
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "StartBy": number,
         "State": "string",
         "StatusMessage": "string",
         "VaultLockState": "string",
         "VaultType": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListBackupJobs_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [BackupJobs](#API_ListBackupJobs_ResponseSyntax) **   <a name="Backup-ListBackupJobs-response-BackupJobs"></a>
結構陣列，其中包含以 JSON 格式傳回的備份任務相關中繼資料。  
類型：[BackupJob](API_BackupJob.md) 物件陣列

 ** [NextToken](#API_ListBackupJobs_ResponseSyntax) **   <a name="Backup-ListBackupJobs-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

## 錯誤
<a name="API_ListBackupJobs_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListBackupJobs_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupJobs)