Help Center/Host Security Service/API Reference/API Description/Ransomware Prevention/Querying the Protection Policy List of Ransomware
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying the Protection Policy List of Ransomware

Function

This API is used to query the protection policy list of ransomware.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/ransomware/protection/policy

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

offset

No

Integer

Definition

Start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

0

limit

No

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10 to 200

Default Value

10

policy_name

No

String

Definition

Protection policy name.

Constraints

N/A

Range

The value can contain 0 to 255 characters.

Default Value

N/A

protect_policy_id

No

String

Definition

Protection policy ID.

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

operating_system

No

String

Definition

OS supported by the policy.

Constraints

N/A

Range

Its value can be:

  • Windows

  • Linux

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

region

No

String

Definition

Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID.

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Definition

Total number of policies.

Range

Value range: 0 to 2,097,152

data_list

Array of ProtectionPolicyInfo objects

Definition

Query the protection policy list.

Range

Value range: 0 to 2,097,152

Table 5 ProtectionPolicyInfo

Parameter

Type

Description

policy_id

String

Definition

Policy ID

Range

The value contains 0 to 128 characters.

policy_name

String

Definition

Protection policy name

Range

The value contains 1 to 128 characters.

protection_mode

String

Definition

Action.

Range

The options are as follows:

  • alarm_and_isolation: Report an alarm and isolate

  • alarm_only: Only report an alarm

bait_protection_status

String

Definition

Whether to enable honeypot protection.

Range

The options are as follows. By default, honeypot protection is enabled.

  • opened

deploy_mode

String

Definition

Whether to enable dynamic honeypot protection.

Range

The options are as follows. By default, dynamic honeypot protection is disabled.

  • opened

  • closed

protection_directory

String

Definition

Protected directory

Range

The value contains 1 to 128 characters.

protection_type

String

Definition

Types of files to be protected.

Range

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

Definition

(Optional) excluded directory

Range

The value contains 1 to 128 characters.

runtime_detection_status

String

Definition

Whether to perform runtime checks.

Range

The options are as follows. Currently, it can only be disabled. This field is reserved.

  • opened

  • closed

runtime_detection_directory

String

Definition

Runtime check directory. This field is reserved.

Range

The value contains 1 to 128 characters.

count_associated_server

Integer

Definition

Number of associated servers

Range

Value range: 0-2097152

operating_system

String

Definition

OS type.

  • Linux

  • Windows

Range

The value contains 1 to 128 characters.

process_whitelist

Array of TrustProcessInfo objects

Process whitelist

default_policy

Integer

Definition

Whether a policy is the default policy.

Range

The options are as follows:

  • 0: non-default policy

  • 1: default policy

ai_protection_status

String

Definition

Whether to enable AI ransomware protection.

Range

  • opened

  • closed

Table 6 TrustProcessInfo

Parameter

Type

Description

path

String

Definition

Process path.

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

hash

String

Definition

Process hash.

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

Example Requests

Query the protection policy list of ransomware. If limit is not specified, 10 records are returned by default.

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

Example Responses

Status code: 200

Request succeeded.

{
  "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"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Ransomware Prevention