批量启动或取消主机扫描任务
功能介绍
批量启动或取消主机漏洞扫描任务
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v3/{project_id}/hostscan/hosts/scan
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
用户的project_id 最小长度：32 最大长度：32 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：102400 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
hosts |
否 |
Array of strings |
主机ID列表 最小长度：1 最大长度：64 数组长度：1 - 100 |
|
action |
否 |
String |
对扫描任务的操作:
枚举值：
|
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
results |
Array of results objects |
扫描任务ID对应主机id列表 数组长度：0 - 100 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：0 最大长度：50 |
|
error_msg |
String |
错误描述 最小长度：0 最大长度：256 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：0 最大长度：50 |
|
error_msg |
String |
错误描述 最小长度：0 最大长度：256 |
状态码： 418
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
错误码
请参见错误码。
