本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeScanJob
返回指定 ScanJob ID 的扫描任务详细信息。
请求语法
GET /scan/jobs/ScanJobId HTTP/1.1
URI 请求参数
请求使用以下 URI 参数。
- ScanJobId
-
对扫描资源的请求 AWS Backup 进行唯一标识。
是否必需:是
请求体
该请求没有请求正文。
响应语法
HTTP/1.1 200
Content-type: application/json
{
"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 格式返回以下数据。
- AccountId
-
返回拥有扫描任务的账户 ID。
模式:
^[0-9]{12}$类型:字符串
- BackupVaultArn
-
用于唯一标识备份库的 Amazon 资源名称 (ARN);例如,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault类型:字符串
- BackupVaultName
-
用于存储备份的逻辑容器的名称。Backup 存储库由用于创建备份存储库的账户和创建备份存储库的 AWS 区域所特有的名称进行标识。
模式:
^[a-zA-Z0-9\-\_\.]{2,50}$类型:字符串
- CompletionDate
-
备份索引创建完成的日期和时间,采用 Unix 时间格式和协调世界时(UTC)。
CompletionDate的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型:时间戳
- CreatedBy
-
包含有关创建扫描任务的识别信息,包括启动扫描的备份计划和规则。
类型:ScanJobCreator 对象
- CreationDate
-
备份索引创建完成的日期和时间,采用 Unix 时间格式和协调世界时(UTC)。
CreationDate的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型:时间戳
- IamRoleArn
-
唯一标识备份保管库的 Amazon 资源名称 (ARN);例如,
arn:aws:iam::123456789012:role/S3Access。类型:字符串
- MalwareScanner
-
用于相应扫描任务的扫描引擎。目前仅支持
GUARDUTY。类型:字符串
有效值:
GUARDDUTY - RecoveryPointArn
-
一个 ARN,用于唯一标识要扫描的目标恢复点。;例如,。
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45类型:字符串
- ResourceArn
-
一个 ARN,用于唯一标识相应恢复点 ARN 的源资源。
类型:字符串
- ResourceName
-
属于指定备份的资源的非唯一名称。
类型:字符串
- ResourceType
-
要备份的 AWS 资源类型;例如,亚马逊 Elastic Block Store (Amazon EBS) 卷。
模式:
^[a-zA-Z0-9\-\_\.]{1,50}$类型:字符串
有效值:
EBS | EC2 | S3 - ScanBaseRecoveryPointArn
-
一个 ARN,用于唯一标识扫描的基本恢复点。只有在执行增量扫描任务时,才会填充此字段。
类型:字符串
- ScanId
-
Amazon GuardDuty 为相应的 Scan Job ID 请求生成的扫描 ID AWS Backup。
类型:字符串
- ScanJobId
-
唯一标识请求的扫描任务 ID AWS Backup。
类型:字符串
- ScanMode
-
指定用于扫描任务的扫描类型。
类型:字符串
有效值:
FULL_SCAN | INCREMENTAL_SCAN - ScannerRoleArn
-
指定用于扫描任务的扫描器 IAM 角色 ARN。
类型:字符串
- ScanResult
-
包含扫描任务和返回的
THREATS_FOUND或已完成任务NO_THREATS_FOUND的。ScanResultsStatus类型:ScanResultInfo 对象
- State
-
扫描任务的当前状态。
类型:字符串
有效值:
CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING - StatusMessage
-
一条详细消息,解释备份资源作业的状态。
类型:字符串
错误
有关所有操作返回的常见错误的信息,请参阅常见错误。
- InvalidParameterValueException
-
表示参数的值有问题。例如,该值超出了范围。
- Context
- Type
HTTP 状态代码:400
- MissingParameterValueException
-
表示缺少必需的参数。
- Context
- Type
HTTP 状态代码:400
- ResourceNotFoundException
-
该操作所需的资源不存在。
- Context
- Type
HTTP 状态代码:400
- ServiceUnavailableException
-
由于服务器发生临时故障而导致请求失败。
- Context
- Type
HTTP 状态代码:500
另请参阅
有关以特定语言之一使用此 API 的更多信息 AWS SDKs,请参阅以下内容: