ListBackupJobs - AWS Backup
请求语法URI 请求参数请求正文响应语法响应元素错误另请参阅

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

ListBackupJobs

返回过去 30 天内经过身份验证的账户的现有备份任务列表。在更长的一段时间内，可以考虑使用这些监控工具。

请求语法

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

URI 请求参数

请求使用以下 URI 参数。

ByAccountId

用于列出任务的账户 ID。仅返回与指定账户 ID 关联的备份任务。

如果从AWS Organizations管理账户中使用，pass* 会返回组织内的所有职位。

模式：^[0-9]{12}$

ByBackupVaultName

仅返回将存储在指定备份库中的备份任务。备份文件库由用于创建它们的账户和创建它们的 AWS 区域所特有的名称标识。它们包含小写字母、数字和连字符。

模式：^[a-zA-Z0-9\-\_]{2,50}$

ByCompleteAfter

仅返回在 Unix 格式和协调世界时 (UTC)) 之后完成的备份作业。

ByCompleteBefore

仅返回在 Unix 格式和协调世界时 (UTC)) 之前完成的备份作业。

ByCreatedAfter

仅返回在指定日期之后创建的备份任务。

ByCreatedBefore

仅返回在指定日期之前创建的备份任务。

ByParentJobId

这是一个根据父任务 ID 列出子（嵌套）作业的过滤器。

ByResourceArn

仅返回与指定资源Amazon 资源名称 (ARN) 匹配的备份任务。

ByResourceType

仅返回指定资源的备份任务：

  • Aurora适用于Amazon Aurora

  • DocumentDBAmazon DB (with DB comMongoDB ilaty)

  • DynamoDB适用于Amazon DynamoDB

  • EBSAmazon Elastic Bl

  • EC2Amazon Elastic Ela

  • EFSAAmazon Elastic File System

  • FSxAmazon FSx FS

  • NeptuneAAmazon Neptune

  • RDSAAmazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

  • S3 适用于 Amazon S3 的

  • VirtualMachine用于虚拟机

模式：^[a-zA-Z0-9\-\_\.]{1,50}$

ByState

仅返回处于指定状态的备份任务。

有效值: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

MaxResults

要退回的商品的最大数量。

有效范围：最小值为 1。最大值为 1 000。

NextToken

部分退回物品列表之后的下一个项目。例如，如果请求返回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",
            "BackupPlanVersion": "string",
            "BackupRuleId": "string"
         },
         "CreationDate": number,
         "ExpectedCompletionDate": number,
         "IamRoleArn": "string",
         "IsParent": boolean,
         "ParentJobId": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "StartBy": number,
         "State": "string",
         "StatusMessage": "string"
      }
   ],
   "NextToken": "string"
}

响应元素

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

BackupJobs

包含以 JSON 格式返回的有关备份任务的元数据的结构数组。

类型：BackupJob 对象数组

NextToken

部分退回物品列表之后的下一个项目。例如，如果请求返回maxResults数量的项目，则NextToken允许您从下一个令牌指向的位置开始返回列表中的更多项目。

类型：字符串

错误

有关所有操作常见错误的信息，请参阅常见错误。

InvalidParameterValueException

表示参数的值有问题。例如，该值超出范围。

HTTP 状态代码：400

ServiceUnavailableException

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

HTTP 状态代码：500

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：