ListBackupJobs - AWS Backup

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

ListBackupJobs

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

请求语法

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

列出作业的账户 ID。仅返回与指定账户 ID 关联的备份作业。

如果从 AWS Organizations 管理账户使用,则传递 * 会在整个组织中返回所有备份作业。

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

ByBackupVaultName

仅返回将存储在指定备份库中的备份作业。备份保管库的名称在创建它们的账户和创建它们的 AWS 区域中是唯一的。名称包含小写字母、数字和连字符。

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

ByCompleteAfter

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

ByCompleteBefore

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

ByCreatedAfter

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

ByCreatedBefore

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

ByMessageCategory

这是一个可选参数,可用于筛选出与您输入 MessageCategory 的值匹配的作业。

例如,字符串可能包括 AccessDeniedSUCCESSAGGREGATE_ALLInvalidParameters

查看监控

通配符 () 返回所有消息类别的计数。

AGGREGATE_ALL 汇总所有消息类别的作业计数并返回总和。

ByParentJobId

这是一个筛选器,用于根据父作业 ID 列出子(嵌套)作业。

ByResourceArn

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

ByResourceType

仅返回指定资源的备份作业:

  • Aurora:表示 Amazon Aurora

  • CloudFormation:表示 AWS CloudFormation

  • DocumentDB:表示 Amazon DocumentDB(与 MongoDB 兼容)

  • 适用于 Amazon DynamoDB 的 DynamoDB

  • 适用于 Amazon Elastic Block Store 的 EBS

  • 适用于 Amazon Elastic Compute Cloud 的 EC2

  • 适用于 Amazon Elastic File System 的 EFS

  • 适用于 Amazon FSx 的 FSx

  • Neptune:表示 Amazon Neptune

  • Redshift:表示 Amazon Redshift

  • RDS:表示 Amazon Relational Database Service

  • SAP HANA on Amazon EC2:表示 SAP HANA 数据库

  • 适用于 AWS Storage Gateway 的 Storage Gateway

  • S3:表示 Amazon S3

  • 适用于 Amazon Timestream 的 Timestream

  • VirtualMachine:表示虚拟机

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

ByState

仅返回处于指定状态的备份作业。

Completed with issues 是仅在 AWS Backup 控制台中显示的状态。对于 API 来说,此状态是指状态为 COMPLETEDMessageCategory 且值不是 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

要返回的最大项目数量。

有效范围:最小值为 1。最大值为 1000。

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", "InitiationDate": number, "IsParent": boolean, "MessageCategory": "string", "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 SDK 中使用此 API 的更多信息,请参阅以下内容: