ListBackupJobSummaries - AWS Backup

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

ListBackupJobSummaries

此请求提供最近 30 天内创建的或正在运行的备份作业的摘要。您可以添加参数 accountID、State、 ResourceType、、 MessageCategory AggregationPeriod MaxResults、 NextToken 或来筛选结果。

此请求返回包含区域、账户、州、、 ResourceType MessageCategory StartTime EndTime、和包含任务数量的摘要。

请求语法

GET /audit/backup-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1

URI 请求参数

请求使用以下 URI 参数。

AccountId

返回指定账户的作业计数。

如果请求是从成员账户或不属于 Organizations 的 AWS 账户发送的,则将返回申请者账户中的职位。

根账户、管理员和委派管理员账户可以使用值 ANY 来返回组织中每个账户中的作业计数。

AGGREGATE_ALL 汇总经过身份验证的组织内所有账户中的作业计数,然后返回总和。

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

AggregationPeriod

返回结果的时间段。

  • ONE_DAY-过去 14 天的每日任务数。

  • SEVEN_DAYS-过去 7 天的汇总任务数。

  • FOURTEEN_DAYS-过去 14 天的汇总任务数。

有效值:ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MaxResults

要返回的最大项目数量。

值为整数。接受的值范围为 1 到 500。

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

MessageCategory

此参数返回指定消息类别的作业计数。

接受的字符串示例包括 AccessDeniedSuccessInvalidParameters。有关可接受 MessageCategory 字符串的列表,请参阅监控

值 ANY 返回所有消息类别的计数。

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

NextToken

所返回资源的部分列表的后续下一个项目。例如,如果请求返回 MaxResults 数量的资源,则 NextToken 允许您从下一个令牌指向的位置开始返回列表中的更多项目。

ResourceType

返回指定资源类型的作业计数。使用请求 GetSupportedResourceTypes 获取支持的资源类型的字符串。

值 ANY 会返回所有资源类型的计数。

AGGREGATE_ALL 汇总所有资源类型的作业计数并返回总和。

要备份的 AWS 资源类型;例如,亚马逊弹性区块存储 (Amazon EBS) Block Store 卷或亚马逊关系数据库服务 (Amazon RDS) 数据库。

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

State

此参数返回具有指定状态的作业的作业计数。

值 ANY 会返回所有状态的计数。

AGGREGATE_ALL 汇总所有资源类型的作业计数并返回总和。

Completed with issues 是仅在 AWS Backup 控制台中显示的状态。对于 API 来说,此状态是指状态为 COMPLETEDMessageCategory 且值不是 SUCCESS 的作业,即,状态为已完成但带有状态消息的作业。要获取 Completed with issues 的作业计数,请运行两个 GET 请求,然后减去第二个较小的数字:

GET /audit/?backup-job-summaries AggregationPeriod=fourteen_days&state=已完成

GET /audit/?backup-job-summaries AggregationPeriod=FOURTEEN_DAYS& =成功&状态= MessageCategory 已完成

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

请求正文

该请求没有请求正文。

响应语法

HTTP/1.1 200 Content-type: application/json { "AggregationPeriod": "string", "BackupJobSummaries": [ { "AccountId": "string", "Count": number, "EndTime": number, "MessageCategory": "string", "Region": "string", "ResourceType": "string", "StartTime": number, "State": "string" } ], "NextToken": "string" }

响应元素

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

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

AggregationPeriod

返回结果的时间段。

  • ONE_DAY-过去 14 天的每日任务数。

  • SEVEN_DAYS-过去 7 天的汇总任务数。

  • FOURTEEN_DAYS-过去 14 天的汇总任务数。

类型:字符串

BackupJobSummaries

摘要信息。

类型:BackupJobSummary 对象数组

NextToken

所返回资源的部分列表的后续下一个项目。例如,如果请求返回 MaxResults 数量的资源,则 NextToken 允许您从下一个令牌指向的位置开始返回列表中的更多项目。

类型:字符串

错误

有关所有操作返回的常见错误的信息,请参阅常见错误

InvalidParameterValueException

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

HTTP 状态代码:400

ServiceUnavailableException

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

HTTP 状态代码:500

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: