ListBackupJobSummaries

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

此请求返回的摘要包含区域、账户、状态、资源类型、消息类别、开始时间、结束时间和所包含作业的计数。

请求语法


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

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

如果请求是从成员账户或不属于 AWS Organizations 的账户发送的，则将返回请求者账户中的作业。

根账户、管理员和委派管理员账户可以使用值 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

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

接受的字符串示例包括 AccessDenied、Success 和 InvalidParameters。查看监控以获取接受的 MessageCategory 字符串的列表。

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

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

NextToken

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

ResourceType

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

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

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

要备份的 AWS 资源的类型；例如 Amazon Elastic Block Store (Amazon EBS) 卷或 Amazon Relational Database Service (Amazon RDS) 数据库。

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

State

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

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

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

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

GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED

GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED

请求正文

该请求没有请求正文。

响应语法


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