扫描引擎组操作
证书的警告
注意,使用扫描引擎需要系统管理员凭据
/ AppSpiderEnterprise / rest / v1 / GetAllEngineGroups
检索扫描引擎组列表
参数没有参数
响应消息
响应状态码 |
原因 |
---|---|
200 |
好吧 |
反应的例子:
JSON模式:
1{2“类型”:“对象”,3.“属性”:{4“EngineGroups”:{5“类型”:“数组”,6“属性”:{7“Id”:{8“类型”:“字符串”,9“要求”:真正的10},11“名称”:{12“类型”:“字符串”,13“要求”:真正的,14“最大长度”:12815},16“描述”:{17“类型”:[“字符串”,“零”]18“要求”:真正的,19“最大长度”:25620.},21“监控”:{22“类型”:“布尔”,23“要求”:真正的,24}25}26},27“additionalProperties”:假28},29“IsSuccess”:{30.“类型”:“布尔”,31“要求”:真正的32},33“ErrorMessage”:{34“类型”:[“字符串”,“零”],35“要求”:真正的36“原因”:{37“类型”:[“字符串”,“零”],38“要求”:真正的39}40},41“additionalProperties”:假42}
/ AppSpiderEnterprise /休息/ v1 / EngineGroup / GetEngineGroupsForClient
检索客户端扫描引擎组列表。
证书的警告
注意:检索扫描引擎组列表所需的用户权限。列表将被限制为用户可以访问的客户端。
参数没有参数
响应消息
响应状态码 |
原因 |
---|---|
200 |
好吧 |
反应的例子:
json
1{2“类型”:“对象”,3.“属性”:{4“EngineGroups”:{5“类型”:“数组”,6“属性”:{7“Id”:{8“类型”:“字符串”,9“要求”:真正的10},11“名称”:{12“类型”:“字符串”,13“要求”:真正的,14“最大长度”:12815},16“描述”:{17“类型”:[“字符串”,“零”],18“要求”:真正的,19“最大长度”:25620.},21“监控”:{22“类型”:“布尔”,23“要求”:真正的24}25}26},27“additionalProperties”:假28},29“IsSuccess”:{30.“类型”:“布尔”,31“要求”:真正的32},33“ErrorMessage”:{34“类型”:[“字符串”,“零”],35“要求”:真正的36},37“原因”:{38“类型”:[“字符串”,“零”],39“要求”:真正的40}41},42“additionalProperties”:假43}
/ AppSpiderEnterprise /休息/ v1 / EngineGroup / SaveEngineGroup
创建或更新扫描引擎组
参数
的名字 |
类型 |
要求 |
描述 |
---|---|---|---|
id |
字符串 |
N |
如果没有提供id,将创建一个新的引擎组。如果提供了id,则执行引擎组更新。 |
的名字 |
字符串 |
Y |
扫描引擎组名称。名称应该是唯一的 |
描述 |
字符串 |
N |
扫描引擎组说明 |
监控 |
保龄球 |
N |
扫描引擎组处于监控状态 |
响应消息
响应状态码 |
原因 |
描述 |
---|---|---|
200 |
已创建扫描引擎组 |
|
400 |
InvalidJsonSchema |
未提供所需参数 |
400 |
EngineGroupNameIsNotUnique |
引擎组名称不唯一 |
400 |
EngineGroupNotFound |
未找到提供id的发动机组 |
反应的例子:
JSON方案:
1{2“类型”:“对象”,3.“属性”:{4“IsSuccess”:{5“类型”:“布尔”,6“要求”:真正的7},8“ErrorMessage”:{9“类型”:[“字符串”,“零”],10“要求”:真正的11},12“原因”:{13“类型”:[“字符串”,“零”],14“要求”:真正的15}16},17“additionalProperties”:假18}
/ AppSpiderEnterprise /休息/ v1 / EngineGroup / DeletEngineGroup
删除扫描引擎组
参数
的名字 |
类型 |
要求 |
描述 |
---|---|---|---|
id |
guid [] |
Y |
扫描引擎组id |
响应消息
响应状态码 |
原因 |
描述 |
---|---|---|
200 |
扫描引擎组被删除 |
|
400 |
InvalidJsonSchema |
未提供所需参数 |
反应的例子:
JSON模式:
1{2“类型”:“对象”,3.“属性”:{4“IsSuccess”:{5“类型”:“布尔”,6“要求”:真正的7},8“ErrorMessage”:{9“类型”:真正的10},11“原因”:{12“类型”:[“字符串”,“零”],13“要求”:真正的14}15},16“additionalProperties”:假17}
/ AppSpiderEnterprise /休息/ v1 / EngineGroup / AddEngineToGroup
添加扫描引擎到扫描引擎组
参数
的名字 |
类型 |
要求 |
描述 |
---|---|---|---|
groupId |
guid |
Y |
扫描引擎组ID |
engineId |
guid |
Y |
扫描引擎ID |
响应消息
响应状态码 |
原因 |
描述 |
---|---|---|
200 |
扫描引擎添加到扫描引擎组 |
|
400 |
InvalidJsonSchema |
未提供所需参数 |
400 |
EngineNotFound |
扫描引擎时引擎id未找到 |
400 |
EngineGroupNotFound |
扫描未找到groupId的引擎组 |
反应的例子:
JSON模式:
1{2“类型”:“对象”,3.“属性”:{4“IsSuccess”:{5“类型”:“布尔”,6“要求”:真正的7},8“ErrorMessage”:{9“类型”:[“字符串”,“零”],10“要求”:真正的'11},12“原因”:{13“类型”:[“字符串”,“零”],14“要求”:真正的15}16},17“additionalProperties”:假18}
/ AppSpiderEnterprise /休息/ v1 / / EngineGroup / DeleteEngineFromGroup
从扫描引擎组中删除扫描引擎
参数
的名字 |
类型 |
要求 |
描述 |
---|---|---|---|
groupId |
guid |
Y |
扫描引擎组ID |
engineId |
guid |
Y |
扫描引擎ID |
响应消息
响应状态码 |
原因 |
描述 |
---|---|---|
200 |
从扫描引擎组中删除扫描引擎 |
|
400 |
InvalidJsonSchema |
未提供所需参数 |
400 |
EngineNotFound |
扫描引擎时引擎id未找到 |
400 |
EngineGroupNotFound |
扫描未找到grouId的引擎组 |
反应的例子:
JSON模式:
1{2“类型”:“对象”,3.“属性”:{4“IsSuccess”:{5“类型”:“布尔”,6“要求”:真正的7},8“ErrorMessage”:{9“类型”:[“字符串”,“零”],10“要求”:真正的11},12“原因”:{13“类型”:[“字符串”,“零”],14“要求”:真正的15}16},17“additionalProperties”:假18}