Querying the Servers Protected Against Ransomware
Function
This API is used to query the list of servers protected against ransomware. This API needs to be used together with Cloud Backup and Recovery (CBR). Ensure the site has CBR before using ransomware-related APIs.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/ransomware/server
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
User 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. The default value is 0. |
limit |
No |
Integer |
Number of records displayed on each page. |
host_name |
No |
String |
Server name |
os_type |
No |
String |
OS type. Its value can be:
|
host_ip |
No |
String |
Server IP address |
host_status |
No |
String |
Server status. Its value can be:
|
last_days |
No |
Integer |
Number of days in the query time range. To query records in the last seven days, set last_days=7. If this parameter is not specified, the events and existing backups in the last day are queried by default. |
Request 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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Total number |
data_list |
Array of ProtectionServerInfo objects |
Query the servers protected against ransomware. |
Parameter |
Type |
Description |
---|---|---|
host_id |
String |
Server ID |
agent_id |
String |
Agent ID |
host_name |
String |
Server name |
host_ip |
String |
EIP |
private_ip |
String |
Private IP address |
os_type |
String |
OS type. Its value can be:
|
os_name |
String |
OS name |
host_status |
String |
Server status. The options are as follows:
|
ransom_protection_status |
String |
Ransomware protection status. The options are as follows:
|
agent_version |
String |
Agent version |
protect_status |
String |
Protection status. Its value can be:
|
group_id |
String |
Server group ID |
group_name |
String |
Server group name |
protect_policy_id |
String |
Policy ID |
protect_policy_name |
String |
Protection policy name |
backup_error |
backup_error object |
Backup error message |
backup_protection_status |
String |
Whether to enable backup. The options are as follows:
|
count_protect_event |
Integer |
Number of protection events |
count_backuped |
Integer |
Existing backups |
agent_status |
String |
Agent status |
version |
String |
HSS edition. Its value can be:
|
host_source |
String |
Indicates the server type. The options are as follows:
|
vault_id |
String |
Vault ID |
vault_name |
String |
Vault name |
vault_size |
Integer |
Total capacity, in GB. |
vault_used |
Integer |
Used capacity, in MB. |
vault_allocated |
Integer |
Allocated bound server capacity, in GB. |
vault_charging_mode |
String |
Repository mode, the value can be post_paid (pay-per-use). |
vault_status |
String |
Vault status can be:
|
backup_policy_id |
String |
Specifies the backup policy ID. If this parameter is empty, the backup policy is not bound. If this parameter is not empty, check whether the backup policy is enabled based on the backup_policy_enabled field. |
backup_policy_name |
String |
Backup policy name |
backup_policy_enabled |
Boolean |
Whether the policy is enabled |
resources_num |
Integer |
Bound servers |
Parameter |
Type |
Description |
---|---|---|
error_code |
Integer |
Error code. The options are as follows:
|
error_description |
String |
Error description |
Example Requests
Query the list of ransomware protection servers. If the limit parameter is not set, 10 records are returned by default.
GET https://{endpoint}/v5/{project_id}/ransomware/server
Example Responses
Status code: 200
List of servers protected against ransomware
{ "total_num" : 1, "data_list" : [ { "agent_id" : "2758d2a61598fd9144cfa6b201049e7c0af8c3f1280cd24e3ec95a2f0811a2a2", "agent_status" : "online", "backup_error" : { "error_code" : 1, "error_description" : "Backup cannot be enabled because another vault has been bound." }, "ransom_protection_status" : "opened", "backup_protection_status" : "failed_to_turn_on_backup", "count_backuped" : 0, "count_protect_event" : 0, "group_id" : "7c659ea3-006f-4687-9f1c-6d975d955f37", "group_name" : "333", "host_id" : "caa958ad-a481-4d46-b51e-6861b8864515", "host_ip" : "100.85.119.68", "host_name" : "Euler", "host_status" : "ACTIVE", "os_name" : "EulerOS", "os_type" : "Linux", "private_ip" : "100.85.123.9", "protect_policy_id" : "0253edfd-30e7-439d-8f3f-17c54c99706", "protect_policy_name" : "tst", "protect_status" : "opened" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
List of servers protected against ransomware |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot