ListRestoreJobSummaries - AWS Backup

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

ListRestoreJobSummaries

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

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

请求语法

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

URI请求参数

该请求使用以下URI参数。

AccountId

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

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

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

NextToken

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

ResourceType

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

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

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

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

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

State

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

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

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

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

请求正文

该请求没有请求正文。

响应语法

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

响应元素

如果操作成功,服务将发回 HTTP 200 响应。

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

AggregationPeriod

返回结果的时间段。

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

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

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

类型:字符串

NextToken

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

类型:字符串

RestoreJobSummaries

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

类型:RestoreJobSummary 对象数组

错误

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

InvalidParameterValueException

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

HTTP状态码:400

ServiceUnavailableException

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

HTTP状态码:500

另请参阅

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