Querying the Protection Policy List of Ransomware
Function
This API is used to query the the protection policy list of ransomware.
URI
GET /v5/{project_id}/ransomware/protection/policy
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. |
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. |
limit |
No |
Integer |
Number of records displayed on each page. |
policy_name |
No |
String |
Policy name |
operating_system |
No |
String |
OSs supported by the policy. The options are as follows:
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
IAM token. It can be obtained by calling the IAM API used to obtain an IAM token. The value of X-Subject-Token in the response header is a token. |
region |
Yes |
String |
Region ID |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Total number of policies |
data_list |
Array of ProtectionPolicyInfo objects |
Query the list of policies. |
Parameter |
Type |
Description |
---|---|---|
policy_id |
String |
Policy ID |
policy_name |
String |
Policy name |
protection_mode |
String |
Action. Its value can be:
|
bait_protection_status |
String |
Whether to enable honeypot protection. By default, the protection is enabled. Its value can be:
|
protection_directory |
String |
Protected directory |
protection_type |
String |
Protected file type, for example, .docx, .txt, and .avi. |
exclude_directory |
String |
(Optional) excluded directory |
runtime_detection_status |
String |
Whether to perform runtime checks. The options are as follows. Currently, it can only be disabled. This field is reserved.
|
runtime_detection_directory |
String |
Directory to be checked during running. This field is reserved. |
count_associated_server |
Integer |
Number of associated servers |
operating_system |
String |
OS type. Its value can be:
|
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
Linux 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" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Linux protection policy list |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.