文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 病毒查杀/ 创建自定义查杀策略 - CreateAntiVirusPolicy
更新时间:2025-10-31 GMT+08:00
分享

创建自定义查杀策略 - CreateAntiVirusPolicy

功能介绍

创建自定义查杀策略

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v5/{project_id}/antivirus/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

policy_name

String

策略名称

start_type

String

启动类型,包含如下:

  • now : 立即启动

  • later : 稍后启动

  • period : 周期启动

scan_period

String

启动类型,包含如下:

  • day :每天

  • week : 每周

  • month : 每月

scan_type

String

任务类型,包含如下:

  • quick :快速扫描

  • full : 全盘扫描

  • custom : 自定义扫描

scan_period_date

Integer

扫描周期日期(1-28;扫描周期为week时,1-7代表周日至周六;扫描周期为month时,1-28代表每月1日到28日)

scan_time

Integer

扫描时间戳,毫秒(仅启动类型为later时有值)

scan_hour

Integer

扫描小时数(仅启动类型为period时有值)

scan_minute

Integer

扫描分钟数(仅启动类型为period时有值)

timezone_offset

Integer

时区偏移量(仅启动类型为period时有值,单位:分钟)

file_types

Array of integers

文件类型集合型,包含如下:

  • 0 :全部

  • 1 : 可执行

  • 2 : 压缩

  • 3 : 脚本

  • 4 : 文档

  • 5 : 图片

  • 6 : 音视频

scan_dir

String

扫描目录,多个用;分隔

ignore_dir

String

排除目录,多个用;分隔

action

String

处置动作,包含如下:

  • auto:自动处置

  • manual:人工处置

whether_paid_task

Boolean

此次扫描任务是否付费

task_id

String

任务ID

host_ids

Array of strings

策略管理主机列表

响应参数

状态码:200

请求已成功

请求示例

创建自定义查杀策略,策略名称为自定义查杀-20250416174356,扫描目录为/root,处置动作为自动处置,主机列表为09724867-7b91-482d-9702-daf9113f1b62,启动类型为立即启动,扫描任务不消耗按次计费配额。

{
  "policy_name" : "自定义查杀-20250416174356",
  "start_type" : "now",
  "file_types" : [ 1, 2, 3, 4 ],
  "scan_dir" : "/root",
  "action" : "auto",
  "whether_paid_task" : false,
  "host_ids" : [ "09724867-7b91-482d-9702-daf9113f1b62" ]
}

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档