调用本接口创建扫描任务。

该API可以用于下发漏洞扫描任务和内容检测任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateScan

系统规定参数。取值:CreateScan。

FlowName String assets

指定扫描任务的扫描模式。

  • assets:资产模式
  • general:标准模式
  • skynet_vul_scan:深度模式
Name String 单次任务

为扫描任务设置任务名称。

Qps Integer 16

指定扫描任务的扫描速度。 可设置:

  • 16:慢速
  • 32:常速
  • 64:快速
RuntimeEnd String 08:00:00

指定扫描任务扫描结束的时间 。

RuntimeStart String 00:00:00

指定扫描任务扫描开始的时间。

ScanType String vuln

指定扫描任务的扫描资产的检测类型。

  • vuln:漏洞类型
  • content:内容风险
  • asset:资产发现
StartDate Long 111122200000

指定扫描任务执行的开始时间。

TriggerType String date

指定扫描任务的触发类型。 可选

  • date:单次任务
  • interval:周期任务
EnableAssetDiscover Integer 1

漏洞扫描任务是否开启资产发现,0,1

EnableAssetLoginScan Integer 1

漏洞扫描任务是否开启登录扫描,0,1

EndDate Long 212212000000

指定扫描任务执行的结束时间。

IndexIntervalInMinute Integer 5

首页检测间隔(分钟)。

  • 5:间隔5分钟
  • 30:间隔30分钟
  • 60:间隔60分钟
Interval Integer 5

指定扫描任务的扫描间隔。

KeyWords.N RepeatList []

附加词库列表。

Period String day

指定扫描任务的扫描周期。

  • day:每天一次
  • week:每周一次
  • month:每月一次
ScanAll Integer 1

扫描所有资产

SiteIntervalInDay Integer 1

全站检测间隔(天)。 可选:

  • 1:每1天一次
  • 7:每7天一次
SourceIp String 1.2.3.4

指定访问者源IP地址。

TargetAssetTags.N RepeatList []

指定待扫描目标资产的标签列表。

Targets.N RepeatList ["***.testfire.net"]

指定待扫描目标资产列表。

返回数据

名称 类型 示例值 描述
Data String { "Data": "2018080617471590979" }

返回的结果数据。

RequestId String 76F297E0-D4C2-442A-AEAD-AABA97975060

返回结果的请求ID。

示例

请求示例


/?Action=CreateScan 
&FlowName=skynet_vul_scan 
&IndexIntervalInMinute=60 
&Name=单次任务 
&Qps=64 
&RuntimeEnd=08:00:00 
&RuntimeStart=00:00:00 
&ScanAll=0 
&ScanType=vuln 
&SiteIntervalInDay=7 
&SourceIp=1.2.3.4
&StartDate=1552898972897 
&TargetAssetTags.1="***.testfire.net" 
&TriggerType=date 
&<公共请求参数>

正常返回示例

XML 格式

<CreateScan>
	  <requestId>76F297E0-D4C2-442A-AEAD-AABA97975060</requestId>
	  <data>
		    <Data>2018080617471590979</Data>
	  </data>
	  <code>200</code>
	  <success>true</success>
    </CreateScan>

JSON 格式

{
	"requestId":"76F297E0-D4C2-442A-AEAD-AABA97975060",
	"data":{
		"Data":"2018080617471590979"
	},
	"code":200,
	"success":true
}

错误码

访问错误中心查看更多错误码。