Querying a Protection Policy List

Function

This API is used to query the list of protection policies.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	User project ID Minimum: 1 Maximum: 256

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Default: 0 Minimum: 1 Maximum: 256
offset	No	Integer	Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. Minimum: 0 Maximum: 2000000 Default: 0
limit	No	Integer	Number of records displayed on each page. Minimum: 10 Maximum: 200 Default: 10
policy_name	No	String	Policy name Minimum: 0 Maximum: 128
protect_policy_id	No	String	Policy ID Minimum: 0 Maximum: 128
operating_system	No	String	OS supported by the policy Minimum: 0 Maximum: 128

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. Minimum: 1 Maximum: 32768
region	Yes	String	region id Minimum: 0 Maximum: 128

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total number Minimum: 0 Maximum: 2097152
data_list	Array of ProtectionPolicyInfo objects	Query the list of policies. Array Length: 0 - 10241

**Table 5** ProtectionPolicyInfo
Parameter	Type	Description
policy_id	String	Policy ID Minimum: 0 Maximum: 128
policy_name	String	Policy name Minimum: 0 Maximum: 128
protection_mode	String	Action. Its value can be: alarm_and_isolation: Report an alarm and isolate. alarm_only: Only report alarms. Minimum: 0 Maximum: 128
bait_protection_status	String	Whether to enable honeypot protection. By default, the protection is enabled. Its value can be: opened closed Minimum: 0 Maximum: 128
deploy_mode	String	Whether to enable honeypot protection. The options are as follows. By default, dynamic honeypot protection is disabled. opened closed Minimum: 0 Maximum: 128
protection_directory	String	Protected directory Minimum: 1 Maximum: 128
protection_type	String	Protected file type Minimum: 0 Maximum: 128
exclude_directory	String	(Optional) excluded directory Minimum: 1 Maximum: 128
runtime_detection_status	String	Whether to perform runtime checks. The options are as follows. Currently, it can only be disabled. This field is reserved. opened closed Minimum: 0 Maximum: 128
runtime_detection_directory	String	Directory to be checked during running. To check all directories, set it to a slash (/). This field is reserved. Minimum: 1 Maximum: 128
count_associated_server	Integer	Number of associated servers Minimum: 0 Maximum: 2097152
operating_system	String	OS type Minimum: 0 Maximum: 128
process_whitelist	Array of TrustProcessInfo objects	Process whitelist Array Length: 0 - 20
default_policy	Integer	Indicates whether the policy is the default policy. The options are as follows: 0: non-default policy 1: default policy Minimum: 0 Maximum: 10

**Table 6** TrustProcessInfo
Parameter	Type	Description
path	String	Indicates the process path. Minimum: 0 Maximum: 128
hash	String	Process hash Minimum: 0 Maximum: 128

Example Requests

Query protection policies. 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

Protection policy list

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