分析命令 (Windows)

分析命令用于提交扫描请求供分析,或者用于处理已经提交的扫描请求。使用这些命令,还可以接收有关扫描的信息。这些信息对于自动执行脚本会非常有用。

使用这些命令之前,请确保先登录到分析服务(请参阅认证命令)。

appscan status

语法:

appscan status -i <job_id>

描述:

对分析作业返回下列其中一个状态:

Pending
Starting
Running
FinishedRunning
FinishedRunningWithErrors
Ready
ReadyIncomplete
FailedToScan
ManuallyStopped
None
Initiating
MissingConfiguration
PossibleMissingConfiguration

必需选项:

  • -i:指定 -i <job_id>,其中 <job_id> 是分析作业的标识。
提示: 对于所有命令,选项都可以按任意顺序使用。

示例:

要查看作业标识 12345 的状态,请指定以下命令:

appscan status -i 12345

如果返回码为 0,说明该作业暂挂。如果返回码为 1,说明作业正在启动,等等。

appscan list

语法:

appscan list

描述:

列出所有分析作业,包括已排队、正在运行和已完成的作业。将返回每个作业的标识,以便您可以将这些标识用于其他命令。例如,可在命令提示符或脚本中将标识用于 info 命令。

注: 此命令最多可返回 2000 次扫描。

appscan list_apps

语法:

appscan list_apps

描述:

使用此命令可以查看您有权访问的 AppScan 360° 应用程序。要使用此命令,必须向服务进行认证。在发出此命令后,将显示 AppScan 360° 应用程序的列表,并在后面的括号中显示应用程序的标识。在使用 queue_analysis 命令的 -a 选项时,请使用此列表中的标识值。

appscan cancel

语法:

appscan cancel -i <job_id>

描述:

取消正在运行或已排队的分析作业。

必需选项:

  • -i:指定 -i <job_id>,其中 <job_id> 是分析作业的标识。
提示: 对于所有命令,选项都可以按任意顺序使用。

示例:

要取消作业标识 12345,请指定以下命令:

appscan cancel -i 12345

appscan queue_analysis

语法:

appscan queue_analysis -a <app_id> -f <file> -n <scan_name> -nen -oso -ps -sao

描述:

提交文件进行分析(IRX 或非 IRX 存档)。扫描完成后,您将收到电子邮件通知(邮件将发送到与登录分析服务时使用的帐户关联的电子邮件地址)。电子邮件包含链接,以便您可以登录来下载扫描。

注: 扫描代码或生成 IRX 文件时,可能会收到有关更新到最新 Static Analyzer Command Line Utility 的消息。请参阅命令行实用程序 (CLI) 支持

必需选项:

  • -f:指定 -f <file>,其中 <file> 是您希望提交以进行扫描的 IRX 文件或者非 IRX 存档。如果文件不在当前目录中,请使用此选项指定文件路径和文件名。
    注: 仅当以下一个或两个语句都满足时,才需要该选项:
    • 您是从包含多个目标文件的目录发出的命令。如果目录仅包含一个目标文件,则在未使用 -f 选项的情况下将提交此文件。
    • 您是从不包含目标文件的目录发出的命令。在此情况下,必须使用 -f 选项指定要提交的文件的路径和文件名。
  • -a:您提交进行分析的文件(IRX 文件或非 IRX 存档)必须与现有 AppScan 360° 应用程序关联。使用此选项,指定 -a <app_id>,其中 <app_id> 是要关联的应用程序的标识。要确定标识,请使用 list_apps 命令。
可选标志/设置:
  • -n:指定 -n <scan_name>,其中 <scan_name> 是所提交扫描的名称。
  • -nen:分析完成时禁用电子邮件通知。如果未指定此标志,缺省情况下将发送电子邮件通知。
    注: -e 标志已弃用,取而代之的是 -nen
  • -ps:将扫描作为个人扫描运行。如果未指定此标志,则缺省情况下将进行常规扫描。
  • -sao:指定 -sao 以仅执行静态分析。
提示: 对于所有命令,选项都可以按任意顺序使用。

示例:

appscan queue_analysis -f my_irx.irx 12345 -n my_scan
要提交 my_irx.irx(位于当前目录中)进行扫描,请使用
appscan queue_analysis -f my_irx.irx -a 12345 -n my_scan
其中 12345 是将扫描关联到的应用程序的标识(可以使用 list_apps 命令来确定应用程序标识)。使用用户界面或 list 命令来查看所有当前扫描时,my_scan 将出现在列表中。

appscan info

语法:

appscan info -i <job_id>

描述:

显示指定分析作业的信息。

提供的信息可以用于自动执行脚本。

必需选项:

  • -i:指定 -i <job_id>,其中 <job_id> 是分析作业的标识。
提示: 对于所有命令,选项都可以按任意顺序使用。

示例:

要接收有关作业标识 12345 的信息,请指定以下命令:

appscan info -i 12345

返回的信息示例如下:

NLowIssues=0
ReadStatus=2
NHighIssues=0
Name=appscan.zip
ScanEndTime=2014-11-20T13:56:04.497Z
Progress=0
RemainingFreeRescanMinutes=0
ParentJobId=00000000-0000-0000-0000-000000000000
EnableMailNotifications=false
JobStatus=6
NInfoIssues=0
JobId=9b344fc7-bc70-e411-b922-005056924f9b
NIssuesFound=0
CreatedAt=2014-11-20T13:54:49.597Z
UserMessage=扫描已成功完成。报告已就绪。
NMediumIssues=0
Result=1