本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# ListBackupJobs


返回过去 30 天内经过身份验证的账户的现有备份作业列表。在较长一段时间内，可以考虑使用这些[监控工具](https://docs.amazonaws.cn/aws-backup/latest/devguide/monitoring.html)。

## 请求语法


```
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 请求参数


请求使用以下 URI 参数。

 ** [ByAccountId](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByAccountId"></a>
列出作业的账户 ID。仅返回与指定账户 ID 关联的备份作业。  
如果从 Amazon Organizations 管理账户中使用，则传递`*`会返回整个组织中的所有作业。  
模式：`^[0-9]{12}$`

 ** [ByBackupVaultName](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByBackupVaultName"></a>
仅返回将存储在指定备份库中的备份作业。备份保管库的名称在创建它们的账户和创建它们的 Amazon 区域中是唯一的。  
模式：`^[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.amazonaws.cn/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 资源名称 (ARN) 匹配的备份作业。

 ** [ByResourceType](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByResourceType"></a>
仅返回指定资源的备份作业：  
+  适用于 Amazon Aurora 的 `Aurora`
+  `CloudFormation`对于 Amazon CloudFormation 
+  适用于 Amazon DocumentDB（与 MongoDB 兼容）的 `DocumentDB`
+  `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`适用于亚马逊 FSx
+  适用于 Amazon Neptune 的 `Neptune`
+  适用于 Amazon Relational Database Service 的 `RDS`
+  适用于 Amazon Redshift `Redshift`
+  `S3`：表示 Amazon Simple Storage Service（Amazon S3）
+  `SAP HANA on Amazon EC2`：表示 Amazon Elastic Compute Cloud 实例上的 SAP HANA 数据库
+  `Storage Gateway`对于 Amazon 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` 是仅在 Amazon Backup 控制台中显示的状态。对于 API 来说，此状态是指状态为 `COMPLETED` 和 `MessageCategory` 且值不是 `SUCCESS` 的作业，即，状态为已完成但带有状态消息的作业。  
要获取 `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` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。

## 请求体


该请求没有请求正文。

## 响应语法


```
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"
}
```

## 响应元素


如果此操作成功，则该服务将会发送回 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` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串

## 错误


有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示参数的值有问题。例如，该值超出了范围。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：400

 ** ServiceUnavailableException **   
由于服务器发生临时故障而导致请求失败。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：500

## 另请参阅


有关以特定语言之一使用此 API 的更多信息 Amazon SDKs，请参阅以下内容：
+  [Amazon 命令行界面 V2](https://docs.amazonaws.cn/goto/cli2/backup-2018-11-15/ListBackupJobs) 
+  [Amazon 适用于.NET 的 SDK V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/backup-2018-11-15/ListBackupJobs) 
+  [Amazon 适用于 C\$1\$1 的 SDK](https://docs.amazonaws.cn/goto/SdkForCpp/backup-2018-11-15/ListBackupJobs) 
+  [Amazon 适用于 Go v2 的 SDK](https://docs.amazonaws.cn/goto/SdkForGoV2/backup-2018-11-15/ListBackupJobs) 
+  [Amazon 适用于 Java 的 SDK V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/backup-2018-11-15/ListBackupJobs) 
+  [Amazon JavaScript V3 版软件开发工具包](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupJobs) 
+  [Amazon 适用于 Kotlin 的 SDK](https://docs.amazonaws.cn/goto/SdkForKotlin/backup-2018-11-15/ListBackupJobs) 
+  [Amazon 适用于 PHP 的 SDK V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/backup-2018-11-15/ListBackupJobs) 
+  [Amazon Python 软件开发工具包](https://docs.amazonaws.cn/goto/boto3/backup-2018-11-15/ListBackupJobs) 
+  [Amazon 适用于 Ruby V3 的 SDK](https://docs.amazonaws.cn/goto/SdkForRubyV3/backup-2018-11-15/ListBackupJobs)