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

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

StartScanJob

开始扫描特定资源的作业。

请求语法

PUT /scan/job HTTP/1.1
Content-type: application/json

{
   "BackupVaultName": "string",
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "MalwareScanner": "string",
   "RecoveryPointArn": "string",
   "ScanBaseRecoveryPointArn": "string",
   "ScanMode": "string",
   "ScannerRoleArn": "string"
}

URI 请求参数

该请求不使用任何 URI 参数。

请求正文

请求接受采用 JSON 格式的以下数据。

BackupVaultName

用于存储备份的逻辑容器的名称。Backup 存储库由用于创建备份存储库的账户和创建备份存储库的 AWS 区域所特有的名称进行标识。

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

类型：字符串

是否必需：是

IamRoleArn

指定用于创建目标恢复点的 IAM 角色 ARN；例如，arn:aws:iam::123456789012:role/S3Access。

类型：字符串

是否必需：是

IdempotencyToken

客户选择的字符串，可用于区分对 StartScanJob 的其他相同调用。使用相同的幂等性令牌重试成功的请求会生成一条成功消息，而不执行任何操作。

类型：字符串

必需：否

MalwareScanner

指定扫描作业期间使用的恶意软件扫描程序。目前仅支持GUARDDUTY。

类型：字符串

有效值：GUARDDUTY

是否必需：是

RecoveryPointArn

唯一标识恢复点的 Amazon 资源名称 (ARN)。这是您进行全面扫描的目标恢复点。如果您正在运行增量扫描，则这将是您在选择基本恢复点后创建的恢复点。

类型：字符串

是否必需：是

ScanBaseRecoveryPointArn

一个 ARN，用于唯一标识用于增量扫描的基本恢复点。

类型：字符串

必需：否

ScanMode

指定扫描作业使用的扫描类型。

包含：

  • FULL_SCAN将扫描备份中的整个数据谱系。

  • INCREMENTAL_SCAN将扫描目标恢复点和基本恢复点 ARN 之间的数据差异。

类型：字符串

有效值：FULL_SCAN | INCREMENTAL_SCAN

是否必需：是

ScannerRoleArn

已指定 IAM 扫描器角色 ARN。

类型：字符串

是否必需：是

响应语法

HTTP/1.1 201
Content-type: application/json

{
   "CreationDate": number,
   "ScanJobId": "string"
}

响应元素

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

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

CreationDate

备份作业的创建日期和时间，采用 Unix 时间格式和协调世界时 (UTC)。CreationDate 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。

类型：时间戳

ScanJobId

唯一标识 AWS Backup 对的资源备份请求。

类型：字符串

错误

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

InvalidParameterValueException

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

Context

Type

HTTP 状态代码：400

InvalidRequestException

表示请求的输入有问题。例如，参数的类型错误。

Context

Type

HTTP 状态代码：400

LimitExceededException

已超过请求中的限制；例如，请求中允许的最大项目数。

Context

Type

HTTP 状态代码：400

MissingParameterValueException

表示缺少必需的参数。

Context

Type

HTTP 状态代码：400

ResourceNotFoundException

该操作所需的资源不存在。

Context

Type

HTTP 状态代码：400

ServiceUnavailableException

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

Context

Type

HTTP 状态代码：500

另请参阅

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