ListScanJobs - AWS Backup

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

ListScanJobs

返回过去 30 天内经过身份验证的账户的现有扫描任务列表。

请求语法

GET /scan/jobs?ByAccountId=ByAccountId&ByBackupVaultName=ByBackupVaultName&ByCompleteAfter=ByCompleteAfter&ByCompleteBefore=ByCompleteBefore&ByMalwareScanner=ByMalwareScanner&ByRecoveryPointArn=ByRecoveryPointArn&ByResourceArn=ByResourceArn&ByResourceType=ByResourceType&ByScanResultStatus=ByScanResultStatus&ByState=ByState&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI 请求参数

请求使用以下 URI 参数。

ByAccountId

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

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

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

ByBackupVaultName

仅返回将存储在指定备份库中的扫描任务。Backup 存储库由用于创建备份存储库的账户和创建备份存储库的 AWS 区域所特有的名称进行标识。

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

ByCompleteAfter

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

ByCompleteBefore

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

ByMalwareScanner

仅返回指定恶意软件扫描程序的扫描任务。目前仅支持GUARDDUTY

有效值:GUARDDUTY

ByRecoveryPointArn

仅返回针对指定恢复点运行的扫描作业。

ByResourceArn

仅返回与指定资源 Amazon 资源名称 (ARN) 匹配的扫描任务。

ByResourceType

按指定的还原测试计划名称返回还原测试选择。

  • EBS适用于 Amazon 弹性区块存储

  • EC2适用于 Amazon 弹性计算云

  • S3适用于亚马逊简单存储服务 (Amazon S3) Simple Service

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

有效值:EBS | EC2 | S3

ByScanResultStatus

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

  • THREATS_FOUND

  • NO_THREATS_FOUND

有效值:NO_THREATS_FOUND | THREATS_FOUND

ByState

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

有效值:CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING

MaxResults

要返回的最大项目数量。

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

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

NextToken

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

请求体

该请求没有请求正文。

响应语法

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "ScanJobs": [ { "AccountId": "string", "BackupVaultArn": "string", "BackupVaultName": "string", "CompletionDate": number, "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "IamRoleArn": "string", "MalwareScanner": "string", "RecoveryPointArn": "string", "ResourceArn": "string", "ResourceName": "string", "ResourceType": "string", "ScanBaseRecoveryPointArn": "string", "ScanId": "string", "ScanJobId": "string", "ScanMode": "string", "ScannerRoleArn": "string", "ScanResult": { "ScanResultStatus": "string" }, "State": "string", "StatusMessage": "string" } ] }

响应元素

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

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

NextToken

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

类型:字符串

ScanJobs

包含以 JSON 格式返回的扫描任务相关元数据的结构数组。

类型:ScanJob 对象数组

错误

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

InvalidParameterValueException

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

Context

Type

HTTP 状态代码:400

ServiceUnavailableException

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

Context

Type

HTTP 状态代码:500

另请参阅

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