扫描管理

得到

/ AppSpiderEnterprise /休息/ v1 /扫描/ GetScans

获取客户端扫描列表

参数没有参数

响应消息

响应状态码

原因

描述

200

响应包含扫描列表

反应的例子:

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“扫描”
5
“类型”“数组”
6
“项目”
7
“类型”“对象”
8
“属性”
9
“Id”
10
“类型”“字符串”
11
“要求”真正的
12
13
“EngineGroupId”
14
“类型”“字符串”“零”
15
“要求”真正的
16
17
“EngineId”
18
“类型”“字符串”“零”
19
“要求”真正的
20.
21
“令牌”
22
“类型”“字符串”“零”
23
“要求”真正的
24
25
“状态”
26
“类型”“整数”
27
“要求”真正的
28
29
“开始时间”
30.
“类型”“字符串”“零”
31
“要求”真正的
32
33
“WindowsScanStart”
34
“类型”“字符串”“零”
35
“要求”真正的
36
37
“WindowScanStop”
38
“类型”“字符串”“零”
39
“要求”真正的
40
41
“StopTime”
42
“类型”“字符串”“零”
43
“要求”真正的
44
45
“CompletionTime”
46
“类型”“字符串”“零”
47
“要求”真正的
48
49
“StartedBy”
50
“类型”“字符串”“零”
51
“要求”真正的
52
53
“ConfigId”
54
“类型”“字符串”“零”
55
“要求”真正的
56
57
“IsApproveRequired”
58
“类型”“布尔”
59
“要求”真正的
60
61
“IsMonitoring”
62
“类型”“布尔”
63
“要求”真正的
64
65
“IsUploaded”
66
“类型”“布尔”
67
“要求”真正的
68
69
“IsImported”
70
“类型”“布尔”
71
“要求”真正的
72
73
“目标”
74
“类型”“数组”
75
“项目”
76
“类型”“对象”
77
“属性”
78
“Id”
79
“类型”“字符串”
80
“要求”真正的
81
82
“主机”
83
“类型”“字符串”
84
“要求”真正的
85
86
87
88
89
90
“additionalProperties”
91
92
93
“IsSuccess”
94
“类型”“布尔”
95
“要求”真正的
96
97
“ErrorMessage”
98
“类型”“字符串”“零”
99
“要求”真正的
One hundred.
101
“原因”
102
“类型”“字符串”“零”
103
“要求”真正的
104
105
106
“additionalProperties”
107

/ AppSpiderEnterprise /休息/ v1 /扫描/ GetScans

通过配置id获取客户端扫描列表

参数

参数

类型

要求

描述

configId

guid []

Y

配置id

响应消息

响应状态码

原因

描述

200

响应包含扫描列表

400

客户端不存在配置Id

反应的例子:

          
json
1
2
“类型”“对象”
3.
“属性”
4
“扫描”
5
“类型”“数组”
6
“项目”
7
“类型”“对象”
8
“属性”
9
“Id”
10
“类型”“字符串”
11
“要求”真正的
12
13
“EngineGroupId”
14
“类型”“字符串”“零”
15
“要求”真正的
16
17
“EngineId”
18
“类型”“字符串”“零”
19
“要求”真正的
20.
21
“令牌”
22
“类型”“字符串”“零”
23
“要求”真正的
24
25
“状态”
26
“类型”“整数”
27
“要求”真正的
28
29
“开始时间”
30.
“类型”“字符串”“零”
31
“要求”真正的
32
33
“WindowsScanStart”
34
“类型”“字符串”“零”
35
“要求”真正的
36
37
“WindowScanStop”
38
“类型”“字符串”“零”
39
“要求”真正的
40
41
“StopTime”
42
“类型”“字符串”“零”
43
“要求”真正的
44
45
“CompletionTime”
46
“类型”“字符串”“零”
47
“要求”真正的
48
49
“StartedBy”
50
“类型”“字符串”“零”
51
“要求”真正的
52
53
“ConfigId”
54
“类型”“字符串”“零”
55
“要求”真正的
56
57
“IsApproveRequired”
58
“类型”“布尔”
59
“要求”真正的
60
61
“IsMonitoring”
62
“类型”“布尔”
63
“要求”真正的
64
65
“IsUploaded”
66
“类型”“布尔”
67
“要求”真正的
68
69
“IsImported”
70
“类型”“布尔”
71
“要求”真正的
72
73
“目标”
74
“类型”“数组”
75
“项目”
76
“类型”“对象”
77
“属性”
78
“Id”
79
“类型”“字符串”
80
“要求”真正的
81
82
“主机”
83
“类型”“字符串”
84
“要求”真正的
85
86
87
88
89
90
“additionalProperties”
91
92
93
“IsSuccess”
94
“类型”“布尔”
95
“要求”真正的
96
97
“ErrorMessage”
98
“类型”“字符串”“零”
99
“要求”真正的
One hundred.
101
“原因”
102
“类型”“字符串”“零”
103
“要求”真正的
104
105
106
“additionalProperties”
107

/ AppSpiderEnterprise /休息/ v1 /扫描/ GetScans

通过分页的配置id检索客户端扫描列表

参数

参数

类型

要求

描述

configId

guid []

Y

配置id

页面

int

Y

返回的结果页(从0开始的页)

页大小

int

Y

每页返回的结果数

响应消息

响应状态码

原因

描述

200

响应包含扫描列表

400

客户端不存在配置Id

反应的例子:

          
json
1
2
“类型”“对象”
3.
“属性”
4
“扫描”
5
“类型”“数组”
6
“项目”
7
“类型”“对象”
8
“属性”
9
“Id”
10
“类型”“字符串”
11
“要求”真正的
12
13
“EngineGroupId”
14
“类型”“字符串”“零”
15
“要求”真正的
16
17
“EngineId”
18
“类型”“字符串”“零”
19
“要求”真正的
20.
21
“令牌”
22
“类型”“字符串”“零”
23
“要求”真正的
24
25
“状态”
26
“类型”“整数”
27
“要求”真正的
28
29
“开始时间”
30.
“类型”“字符串”“零”
31
“要求”真正的
32
33
“WindowsScanStart”
34
“类型”“字符串”“零”
35
“要求”真正的
36
37
“WindowScanStop”
38
“类型”“字符串”“零”
39
“要求”真正的
40
41
“StopTime”
42
“类型”“字符串”“零”
43
“要求”真正的
44
45
“CompletionTime”
46
“类型”“字符串”“零”
47
“要求”真正的
48
49
“StartedBy”
50
“类型”“字符串”“零”
51
“要求”真正的
52
53
“ConfigId”
54
“类型”“字符串”“零”
55
“要求”真正的
56
57
“IsApproveRequired”
58
“类型”“布尔”
59
“要求”真正的
60
61
“IsMonitoring”
62
“类型”“布尔”
63
“要求”真正的
64
65
“IsUploaded”
66
“类型”“布尔”
67
“要求”真正的
68
69
“IsImported”
70
“类型”“布尔”
71
“要求”真正的
72
73
“目标”
74
“类型”“数组”
75
“项目”
76
“类型”“对象”
77
“属性”
78
“Id”
79
“类型”“字符串”
80
“要求”真正的
81
82
“主机”
83
“类型”“字符串”
84
“要求”真正的
85
86
87
88
89
90
“additionalProperties”
91
92
93
“IsSuccess”
94
“类型”“布尔”
95
“要求”真正的
96
97
“ErrorMessage”
98
“类型”“字符串”“零”
99
“要求”真正的
One hundred.
101
“原因”
102
“类型”“字符串”“零”
103
“要求”真正的
104
105
“TotalCount”
106
“类型”“整数”
107
“要求”真正的
108
109
“TotalPages”
110
“类型”“整数”
111
“要求”真正的
112
113
“链接”
114
“类型”“数组”
115
“项目”
116
“Rel”
117
“类型”“字符串”“零”
118
“要求”真正的
119
120
“Href”
121
“类型”“字符串”“零”
122
“要求”真正的
123
124
125
126
127
128
“additionalProperties”
129
帖子

/ AppSpiderEnterprise /休息/ v1 /扫描/ RunScan

开始扫描

注意

至少应该提供一个参数来启动扫描

参数

的名字

类型

要求

描述

configId

guid []

N

扫描配置ID

configName

字符串

N

扫描配置名称

RunScan配置

尽管'configId'和'configName'都不需要,但至少要配置其中一个请求才能成功。

响应消息

响应状态码

原因

描述

200

扫描配置删除

400

InvalidJsonSchema

未提供所需参数

400

ScanStartFailed

客户端不存在带有“configId”的配置。在客户端没有找到配置文件。用户未批准扫描配置目标。

帖子

/ AppSpiderEnterprise /休息/ v1 /扫描/ CancelScan

取消“正在启动”或“等待云”扫描

参数

的名字

类型

要求

描述

scanId

guid []

Y

扫描身份证

响应消息

响应状态码

原因

描述

200

扫描被取消了

400

InvalidJsonSchema

未提供所需参数

反应的例子:

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“IsSuccess”
5
“类型”“布尔”
6
“要求”真正的
7
8
“ErrorMessage”
9
“类型”“字符串”“零”
10
“要求”真正的
11
12
“原因”
13
“类型”“字符串”“零”
14
“要求”真正的
15
16
17
“additionalProperties”
18
帖子

/ AppSpiderEnterprise /休息/ v1 /扫描/ PauseScan

暂停正在运行的扫描

参数

的名字

类型

要求

描述

scanId

guid []

Y

扫描身份证

响应消息

响应状态码

原因

描述

200

扫描是停顿了一下

400

InvalidJsonSchema

未提供所需参数

反应的例子:

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“IsSuccess”
5
“类型”“布尔”
6
“要求”真正的
7
8
“ErrorMessage”
9
“类型”“字符串”“零”
10
“要求”真正的
11
12
“原因”
13
“类型”“字符串”“零”
14
“要求”真正的
15
16
17
“additionalProperties”
18
帖子

/ AppSpiderEnterprise /休息/ v1 /扫描/ ResumeScan

恢复暂停的扫描

参数

的名字

类型

要求

描述

scanId

guid []

Y

扫描身份证

响应消息

响应状态码

原因

描述

200

扫描是恢复

400

InvalidJsonSchema

未提供所需参数

反应的例子:

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“IsSuccess”
5
“类型”“布尔”
6
“要求”真正的
7
8
“ErrorMessage”
9
“类型”“字符串”“零”
10
“要求”真正的
11
12
“原因”
13
“类型”“字符串”“零”
14
“要求”真正的
15
16
17
“additionalProperties”
18
帖子

/ AppSpiderEnterprise /休息/ v1 /扫描/ StopScan

停止正在运行的扫描

参数

的名字

类型

要求

描述

scanId

guid []

Y

扫描身份证

响应消息

响应状态码

原因

描述

200

扫描了

400

InvalidJsonSchema

未提供所需参数

反应的例子:

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“IsSuccess”
5
“类型”“布尔”
6
“要求”真正的
7
8
“ErrorMessage”
9
“类型”“字符串”“零”
10
“要求”真正的
11
12
“原因”
13
“类型”“字符串”“零”
14
“要求”真正的
15
16
17
“additionalProperties”
18
帖子

/ AppSpiderEnterprise /休息/ v1 /扫描/ PauseAllScans

暂停所有正在运行的客户端扫描

参数没有参数

响应消息

响应状态码

原因

描述

200

扫描被停了下来

反应的例子:

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“IsSuccess”
5
“类型”“布尔”
6
“要求”真正的
7
8
“ErrorMessage”
9
“类型”“字符串”“零”
10
“要求”真正的
11
12
“原因”
13
“类型”“字符串”“零”
14
“要求”真正的
15
16
17
“additionalProperties”
18
帖子

/ AppSpiderEnterprise /休息/ v1 /扫描/ ResumeAllScans

恢复所有暂停的客户端扫描

参数没有参数

响应消息

响应状态码

原因

描述

200

扫描被恢复

反应的例子:

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“IsSuccess”
5
“类型”“布尔”
6
“要求”真正的
7
8
“ErrorMessage”
9
“类型”“字符串”“零”
10
“要求”真正的
11
12
“原因”
13
“类型”“字符串”“零”
14
“要求”真正的
15
16
17
“additionalProperties”
18
帖子

/ AppSpiderEnterprise /休息/ v1 /扫描/ StopAllScans

停止对客户端的所有扫描

参数没有参数

响应消息

响应状态码

原因

描述

200

扫描被停止了

反应的例子:

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“IsSuccess”
5
“类型”“布尔”
6
“要求”真正的
7
8
“ErrorMessage”
9
“类型”“字符串”“零”
10
“要求”真正的
11
12
“原因”
13
“类型”“字符串”“零”
14
“要求”真正的
15
16
17
“additionalProperties”
18
帖子

/ AppSpiderEnterprise /休息/ v1 /扫描/ CancelAllScans

取消客户端所有“Starting”和“Waiting for cloud”扫描

参数没有参数

响应消息

响应状态码

原因

描述

200

扫描全部取消

反应的例子:

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“IsSuccess”
5
“类型”“布尔”
6
“要求”真正的
7
8
“ErrorMessage”
9
“类型”“字符串”“零”
10
“要求”真正的
11
12
“原因”
13
“类型”“字符串”“零”
14
“要求”真正的
15
16
17
“additionalProperties”
18
得到

/ AppSpiderEnterprise /休息/ v1 /扫描/ GetScanStatus

检索字符串表示的扫描状态

参数

的名字

类型

要求

描述

scanId

guid []

Y

扫描身份证

响应消息

响应状态码

原因

描述

200

响应包含扫描状态

400

InvalidJsonSchema

未提供所需参数

400

ScanNotFound

扫描没有发现

反应的例子:

返回状态(区分大小写):●“Starting”-扫描正在启动-内部状态使用开始扫描●“运行”-扫描正在运行●“运行..”●“running ....”-内部状态使用运行扫描●“等待云”扫描正在等待云扫描引擎●“停止”扫描正在停止●“停止。”-用于停止扫描的内部状态-内部状态使用停止扫描●“等待停止”-内部状态使用停止扫描●等待停止....-内部状态使用停止扫描●“暂停”-扫描暂停●“暂停..”●“暂停....”-内部状态使用暂停扫描●“恢复”-扫描恢复后暂停●“恢复..” - internal status using for resuming scan ● "Resuming...." - internal status using for resuming scan ● "Canceling" - scan is canceling ● "Canceling.." - internal status using for canceling scan ● "Canceling...." - internal status using for canceling scan ● "Stopped" - scan is stopped ● "Paused" - scan is paused ● "Pending Blackout" - internal status using for blackouted scan ● "Blackouted" - scan is paused by blackout ● "Pending Upload" - internal status using for uploading scan ● "Hanged" - scan is hanged ● "Failed" - scan is failed ● "Vuln Load Failed" - vulnerabilities load from scan report failed ● "Completed" - scan is completed ● "Starting Upload - internal status using for uploading scan ● "Starting Upload.." - internal status using for uploading scan ● "Starting Update" - internal status using for updating scan ● "Deleting All" - scan deleting is in progress ● "Download failed" - scan report download is failed

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“状态”
5
“类型”“字符串”“零”
6
“要求”真正的
7
8
“IsSuccess”
9
“类型”“布尔”
10
“要求”真正的
11
12
“ErrorMessage”
13
“类型”“字符串”“零”
14
“要求”真正的
15
16
“原因”
17
“类型”“字符串”“零”
18
“要求”真正的
19
20.
21
“additionalProperties”
22
得到

/ AppSpiderEnterprise /休息/ v1 /扫描/ IsScanActive

检查指定的扫描是否激活

参数

的名字

类型

要求

描述

scanId

guid []

Y

ScanID

响应消息

响应状态码

原因

描述

200

响应包含布尔值

400

InvalidJsonSchema

未提供所需参数

400

ScanNotFound

扫描没有发现

反应的例子:

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“结果”
5
“类型”“布尔”
6
“要求”真正的
7
8
“IsSuccess”
9
“类型”“布尔”
10
“要求”真正的
11
12
“ErrorMessage”
13
“类型”“字符串”“零”
14
“要求”真正的
15
16
“原因”
17
“类型”“字符串”“零”
18
“要求”真正的
19
20.
21
“additionalProperties”
22
得到

/ AppSpiderEnterprise /休息/ v1 /扫描/ IsScanFinished

检查指定的扫描是否已完成

参数

的名字

类型

要求

描述

scanId

guid []

Y

扫描身份证

响应消息

响应状态码

原因

描述

200

响应包含布尔值

400

InvalidJsonSchema

未提供所需参数

400

ScanNotFound

扫描没有发现

反应的例子:

          
json
1
2
“类型”“对象”
3.
“属性”
4
“结果”
5
“类型”“布尔”
6
“要求”真正的
7
8
“IsSuccess”
9
“类型”“布尔”
10
“要求”真正的
11
12
“ErrorMessage”
13
“类型”“字符串”“零”
14
“要求”真正的
15
16
“原因”
17
“类型”“字符串”“零”
18
“要求”真正的
19
20.
21
“additionalProperties”
22
得到

/ AppSpiderEnterprise /休息/ v1 /扫描/ HasReport

检查指定的扫描是否有报告

参数

的名字

类型

要求

描述

scanId

guid []

Y

扫描身份证

响应消息

响应状态码

原因

描述

200

响应包含布尔值

400

InvalidJsonSchema

未提供所需参数

400

ScanNotFound

扫描没有发现

反应的例子:

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“结果”
5
“类型”“布尔”
6
“要求”真正的
7
8
“IsSuccess”
9
“类型”“布尔”
10
“要求”真正的
11
12
“ErrorMessage”
13
“类型”“字符串”“零”
14
“要求”真正的
15
16
“原因”
17
“类型”“字符串”“零”
18
“要求”真正的
19
20.
21
“additionalProperties”
22
得到

/ AppSpiderEnterprise /休息/ v1 /扫描/ GetScanErrors

获取扫描错误日志

参数

的名字

类型

要求

描述

scanId

guid []

Y

扫描身份证

响应消息

响应状态码

原因

描述

200

响应包含布尔值

400

InvalidJsonSchema

未提供所需参数

400

ScanNotFound

扫描没有发现

400

ScanIsNotAllowed

用户没有权限访问扫描

反应的例子:

          
JSON模式:
1
2
“类型”“对象”
3.
“属性”
4
“事件”
5
“类型”“数组”
6
“属性”
7
“类型”
8
“类型”“字符串”
9
“要求”真正的
10
11
“日期”
12
“类型”“字符串”“零”
13
“要求”真正的
14
15
“消息”
16
“类型”“字符串”“零”
17
“要求”真正的
18
19
20.
“additionalProperties”
21
22
23
“IsSuccess”
24
“类型”“布尔”
25
“要求”真正的
26
27
“ErrorMessage”
28
“类型”“字符串”“零”
29
“要求”真正的
30.
31
“原因”
32
“类型”“字符串”“零”
33
“要求”真正的
34
35
36
“additionalProperties”
37

/ AppSpiderEnterprise /休息/ v1 /扫描/ GetScanStatuses

检索扫描的可能状态列表

参数没有参数

响应消息

响应状态码

原因

描述

200

响应包含扫描状态类型列表

反应的例子:

返回列表的状态扫描(区分大小写)●●开始“开始”——扫描“PendingStarting”——内部状态用于开始扫描●“ValidatingStarting”——内部状态用于开始扫描●“运行”——扫描运行●“ValidateRunning”——内部状态用于运行扫描●“ValidatingRunning”——用于内部状态运行扫描●“StartingCloud”——扫描等待云扫描引擎●“停止”——扫描停止●“PendingStopping”——内部状态用于停止扫描●“ValidatingStopping”——内部状态为停止使用扫描●“ActStopped”——内部状态为停止使用扫描●“ValidateStopped”——内部状态使用●停止扫描“ValidatingStopped”——内部状态为停止使用扫描●“暂停”——扫描暂停●“PendingPausing”——内部状态用于暂停扫描●“ValidatingPausing”——内部状态用于暂停扫描●“恢复”——扫描后恢复暂停●“PendingResuming”——内部状态用于恢复扫描●“ValidatingResuming”内部状态用于恢复扫描●“取消”——扫描取消●“PendingCanceling”——内部状态用于取消扫描●“ValidatingCanceling”——内部状态用于取消扫描●“停止”——停止扫描●“暂停”——扫描暂停●“PendingPauseByBlackout”——内部状态用于停电扫描●“PausedByBlackout”- scan is paused by blackout ● "PendingUpload" - internal status used for uploading scan ● "Hanged" - scan is hanged ● "Failed" - scan is failed ● "VulnLoadFailed" - vulnerabilities load from scan report failed ● "Completed" - scan is completed ● "StartUpload" - internal status used for uploading scan ● "PendingStartUpload" - internal status used for uploading scan ● "ValidatingStartUpload" - internal status used for uploading scan ● "StartUpdate" - internal status used for updating scan ● "StartDeleteWithReports" - scan deleting is in progress ● "ReportError" - scan report download is failed ● "ReportRegenerating" - report regenerating started ● "ReportRegeneratingOnCloud" - report regenerating on Cloud ●"ReportRegeneratingRunning" - report regenerating ● "ReportRegeneratingError" - report regeneration failed ● "ReportRegeneratingCompleted" - report regeneration completed

/ AppSpiderEnterprise /休息/ v1 /扫描/ HasScanImported

检索扫描状态和表示是否已从已完成的扫描中导入漏洞的导入标志

参数

的名字

类型

要求

描述

scanId

guid []

Y

扫描身份证

响应消息

响应状态码

原因

描述

200

响应包含扫描状态和导入标志

400

ScanNotFound

扫描没有发现

          
json
1
2
“类型”“对象”
3.
“属性”
4
“IsImported”
5
“类型”“布尔”
6
“要求”真正的
7
8
“状态”
9
“类型”“字符串”“零”
10
“要求”真正的
11
12
“IsSuccess”
13
“类型”“布尔”
14
“要求”真正的
15
16
“ErrorMessage”
17
“类型”“字符串”“零”
18
“要求”真正的
19
20.
“原因”
21
“类型”“字符串”“零”
22
“要求”真正的
23
24
25
“additionalProperties”
26