查询自定义查杀策略列表 - ListAntiVirusPolicy
功能介绍
查询自定义查杀策略列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/antivirus/policy
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
offset |
是 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 不涉及 |
|
limit |
是 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
policy_name |
否 |
String |
策略名称 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: 总数 取值范围: 最小值0，最大值2147483647 |
|
data_list |
Array of AntiVirusPolicyResponseInfo objects |
data list |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
policy_id |
String |
策略ID |
|
policy_name |
String |
策略名称 |
|
start_type |
String |
启动类型，包含如下:
|
|
scan_period |
String |
启动类型，包含如下:
|
|
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时有值） |
|
next_start_time |
Integer |
下次启动时间，毫秒 |
|
scan_dir |
String |
扫描目录，多个用;分隔 |
|
ignore_dir |
String |
排除目录，多个用;分隔 |
|
action |
String |
处置动作，包含如下:
|
|
invalidate |
Boolean |
失效，包含如下:
|
|
host_num |
Integer |
参数解释: 影响主机数量 取值范围: 最小值0，最大值2147483647 |
|
host_info_list |
Array of AntiVirusPolicyHostResponseInfo objects |
主机信息 |
|
whether_paid_task |
Boolean |
此次扫描任务是否付费 |
|
file_type_list |
Array of integers |
文件类型集合型 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host_id |
String |
参数解释： 主机ID 取值范围： 字符长度1-64位 |
|
host_name |
String |
参数解释: 服务器名称 取值范围: 字符长度1-256位 |
|
private_ip |
String |
参数解释： 服务器私有IP 取值范围： 字符长度1-128位 |
|
public_ip |
String |
参数解释： 弹性公网IP地址 取值范围： 字符长度1-256位 |
|
asset_value |
String |
资产重要性，包含如下3种
|
请求示例
无
响应示例
状态码：200
请求已成功
{
"total_num" : 85,
"data_list" : [ {
"policy_id" : "16***0dc-94cb-4ca3-9087-06***cd168c1",
"policy_name" : "自定义查杀-20240418173443",
"start_type" : "period",
"scan_period" : "day",
"scan_hour" : 17,
"scan_minute" : 40,
"next_start_time" : 1737538800000,
"file_type_list" : [ 1, 2, 3, 4, 6 ],
"scan_dir" : "",
"ignore_dir" : "/test",
"action" : "manual",
"invalidate" : true,
"host_num" : 0,
"host_info_list" : [ ],
"whether_paid_task" : false
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
