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

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

ListScanJobSummaries

此请求提供最近 30 天内创建或正在运行的扫描任务的摘要。

请求语法

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

URI 请求参数

请求使用以下 URI 参数。

AccountId

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

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

root、管理员和委派管理员账户可以使用该值ANY返回组织中每个账户的任务计数。

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

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

AggregationPeriod

返回结果的时间段。

  • ONE_DAY前 1 天的每日任务数。

  • SEVEN_DAYS过去 7 天的每日任务数。

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

有效值：ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MalwareScanner

仅返回指定恶意软件扫描程序的扫描任务。目前唯一 MalwareScanner 的是GUARDDUTY。但是该字段还支持ANY、和AGGREGATE_ALL。

有效值：GUARDDUTY

MaxResults

要返回的最大项目数量。

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

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

NextToken

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

ResourceType

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

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

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

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

ScanResultStatus

仅返回指定扫描结果的扫描作业。

有效值：NO_THREATS_FOUND | THREATS_FOUND

State

仅返回指定扫描任务状态下的扫描作业。

有效值：CREATED | COMPLETED | COMPLETED_WITH_ISSUES | RUNNING | FAILED | CANCELED | AGGREGATE_ALL | ANY

请求正文

该请求没有请求正文。

响应语法

HTTP/1.1 200
Content-type: application/json

{
   "AggregationPeriod": "string",
   "NextToken": "string",
   "ScanJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MalwareScanner": "string",
         "Region": "string",
         "ResourceType": "string",
         "ScanResultStatus": "string",
         "StartTime": number,
         "State": "string"
      }
   ]
}

响应元素

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

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

AggregationPeriod

返回结果的时间段。

  • ONE_DAY前 1 天的每日任务数。

  • SEVEN_DAYS过去 7 天的每日任务数。

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

有效值：'ONE_DAY' | 'SEVEN_DAYS' | 'FOURTEEN_DAYS'

类型：字符串

NextToken

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

类型：字符串

ScanJobSummaries

摘要信息。

类型：ScanJobSummary 对象数组

错误

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

InvalidParameterValueException

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

Context

Type

HTTP 状态代码：400

ServiceUnavailableException

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

Context

Type

HTTP 状态代码：500

另请参阅

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：