文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 勒索防护/ 查询勒索病毒的防护策略列表 - ListProtectionPolicy
更新时间:2025-10-31 GMT+08:00
分享

查询勒索病毒的防护策略列表 - ListProtectionPolicy

功能介绍

查询勒索病毒的防护策略列表

授权信息

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

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

URI

GET /v5/{project_id}/ransomware/protection/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)。

offset

Integer

参数解释:

指定返回记录的开始位置

约束限制:

不涉及

取值范围:

取值0-2000000

默认取值:

0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

policy_name

String

参数解释:

防护策略名称

约束限制:

不涉及

取值范围:

字符长度0-255

默认取值:

不涉及

protect_policy_id

String

参数解释:

防护策略id

约束限制:

不涉及

取值范围:

字符长度0-128

默认取值:

不涉及

operating_system

String

参数解释:

策略支持的操作系统

约束限制:

不涉及

取值范围:

包含如下:

  • Windows : Windows系统

  • Linux : Linux系统

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

策略总数

取值范围:

取值0-2097152

data_list

Array of ProtectionPolicyInfo objects

参数解释:

查询防护策略列表

取值范围:

取值0-2097152

表5 ProtectionPolicyInfo

参数

参数类型

描述

policy_id

String

参数解释:

策略ID

取值范围:

字符长度0-128

policy_name

String

参数解释:

防护策略名称

取值范围:

字符长度1-128

protection_mode

String

参数解释:

防护动作

取值范围:

包含如下2种。

  • alarm_and_isolation :告警并自动隔离。

  • alarm_only :仅告警。

bait_protection_status

String

参数解释:

是否开启诱饵防护

取值范围:

包含如下1种,默认为开启防护诱饵防护。

  • opened :开启。

deploy_mode

String

参数解释:

是否开启动态诱饵防护

取值范围:

包含如下2种,默认为关闭动态诱饵防护。

  • opened :开启。

  • closed :关闭。

protection_directory

String

参数解释:

防护目录

取值范围:

字符长度1-128

protection_type

String

参数解释:

需要防护的文件类型

取值范围:

txt、csv、rtf、doc、docx、xls、xlsx、ppt、pptx、pdf、xml、json、sql、mdf、dbf、ldf、db、myd、wdb、si、cfs、cfe、fnm、fdx、fdt、tvx、tvf、tvd、tim、nvd、nvm、dvd、dvm、jpeg、bmp、gif、png、tiff、eps、mp3、mp4、avi、mpg、wmv、RMVB、mov、3pg、swf、flv、rar、gz、tgz、zip、7z、cpp、c、java、asp、php、python、html、js、vdi、vmdk、vdx、ovf、qcow2、vmem、vswp、img、bak、back、cer、crt、pem、key、csr

exclude_directory

String

参数解释:

排除目录,选填

取值范围:

字符长度1-128

runtime_detection_status

String

参数解释:

是否运行时检测

取值范围:

包含如下2种,暂时只有关闭一种状态,为保留字段。

  • opened :开启。

  • closed :关闭。

runtime_detection_directory

String

参数解释:

运行时检测目录,现在为保留字段

取值范围:

字符长度1-128

count_associated_server

Integer

参数解释:

关联server个数

取值范围:

取值范围0-2097152

operating_system

String

参数解释:

操作系统类型。

  • Linux

  • Windows

取值范围:

字符长度1-128

process_whitelist

Array of TrustProcessInfo objects

进程白名单

default_policy

Integer

参数解释:

是否为默认策略

取值范围:

包含如下2种。

  • 0 :非默认策略。

  • 1 :默认策略

ai_protection_status

String

参数解释:

是否开启AI勒索防护

取值范围:

  • opened :开启。

  • closed :关闭。

表6 TrustProcessInfo

参数

参数类型

描述

path

String

参数解释:

进程路径

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

hash

String

参数解释:

进程hash

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

请求示例

查询勒索病毒的防护策略列表,不传limit参数默认返回10条数据。

GET https://{endpoint}/v5/{project_id}/ransomware/protection/policy

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "bait_protection_status" : "opened",
    "exclude_directory" : "/opt",
    "count_associated_server" : 0,
    "operating_system" : "Linux",
    "protection_mode" : "alarm_only",
    "policy_id" : "4117d16-074b-41ae-b7d7-9cc25ee258",
    "policy_name" : "test",
    "protection_directory" : "/dd",
    "protection_type" : "docx",
    "runtime_detection_status" : "closed"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档