九游平台/ 漏洞管理服务 codearts inspector/ api参考/ / / 批量启动或取消主机扫描任务
更新时间：2024-10-14 gmt 08:00

批量启动或取消主机扫描任务-九游平台

功能介绍

批量启动或取消主机漏洞扫描任务

调试

您可以在中调试该接口，支持自动认证鉴权。api explorer可以自动生成sdk代码示例，并提供sdk代码示例调试功能。

uri

post /v3/{project_id}/hostscan/hosts/scan

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

string

用户的project_id

最小长度：32

最大长度：32

请求参数

表2 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

用户token，通过调用iam服务获取用户token接口获取（响应消息头中x-subject-token的值）。

最小长度：1

最大长度：102400
表3 请求body参数

参数

是否必选

参数类型

描述

hosts

否

array of strings

主机id列表

最小长度：1

最大长度：64

数组长度：1 - 100

action

否

string

对扫描任务的操作:

  • start - 启动

  • cancel - 取消

枚举值：

  • start

  • cancel

响应参数

状态码： 200

表4 响应body参数

参数

参数类型

描述

results

array of results objects

扫描任务id对应主机id列表

数组长度：0 - 100
表5 results

参数

参数类型

描述

scan_id

string

扫描id

最小长度：1

最大长度：64

host_id

string

主机id

最小长度：1

最大长度：64

状态码： 400

表6 响应body参数

参数

参数类型

描述

error_code

string

错误码

最小长度：0

最大长度：50

error_msg

string

错误描述

最小长度：0

最大长度：256

状态码： 401

表7 响应body参数

参数

参数类型

描述

error_code

string

错误码

最小长度：0

最大长度：50

error_msg

string

错误描述

最小长度：0

最大长度：256

状态码： 418

表8 响应body参数

参数

参数类型

描述

error_code

string

错误码

最小长度：0

最大长度：50

error_msg

string

错误描述

最小长度：0

最大长度：256

请求示例

post https://{endpoint}/v3/{project_id}/hostscan/hosts/scan
{
  "action" : 0,
  "hosts" : [ "9a1cd36501a94a739db18a53ba07e35a" ]
}

响应示例

状态码： 200

ok

{
  "results" : [ {
    "scan_id" : "473aca3eafab468198c23f36d540d112",
    "host_id" : "9a1cd36501a94a739db18a53ba07e35a"
  } ]
}

状态码

状态码

描述

200

ok

400

bad request

401

unauthorized

418

i'm a teapot

错误码

请参见错误码。

父主题：

相关文档

网站地图