创建病毒扫描任务 - CreateAntiVirusTask
功能介绍
创建病毒扫描任务
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/antivirus/task
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
region |
否 |
String |
参数解释: 区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID。 约束限制: 不涉及 取值范围: 字符长度1-128位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_name |
是 |
String |
任务名称 |
|
task_id |
否 |
String |
任务ID 创建病毒扫描任务时,task_id是null.重新扫描时,task_id不是null,是当前任务的ID |
|
scan_type |
是 |
String |
任务类型,包含如下:
|
|
action |
是 |
String |
处置动作,包含如下:
|
|
host_ids |
是 |
Array of strings |
策略管理主机列表 |
响应参数
状态码:200
请求已成功
无
请求示例
编辑任务名称为任务的病毒扫描任务,任务类型为快速扫描,处置动作为人工处置,主机列表为eab583a8-ff16-4b7a-aefc-e95ad3a78388
{
"task_name" : "任务",
"scan_type" : "quick",
"action" : "manual",
"host_ids" : [ "eab583a8-ff16-4b7a-aefc-e95ad3a78388" ]
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。