Get virus scan info of a virtual server

NAS File Storage REST API v7 Reference

Version
14.7.x
14.6.x
Audience
anonymous
Part Number
MK-92HNAS088-05

Retrieves virus scan info of a virtual server in the system.

HTTP request syntax (URI)

GET <base_URI>/v7/storage/virtual-servers/{id}/virus-scan

Parameters

Name Type Required Values Description
id URI_PARAM Y string/number Specifies either the virtual server object ID or the HNAS storage virtual server ID.

Return codes

Code Data Description
200 virusScan Virus scan info of a virtual server successfully retrieved.
400 No Data Missing or invalid request contents.
404 Error Message Requested resource not found.
500 Error message Error associated with the storage system.
501 No Data Server has not implemented the request operation on the resource.

Any HTTP status code other than 200 indicates that the API did not complete successfully.

Request example: Using the virtual server object ID

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/virtual-servers/ 313a3a3a4f49445f24232140255f56/virus-scan

Response example: Using the virtual server object ID

{
   "virusScan" : {
      "areAllFileTypesScanned" : true,
      "fileExtensions" : [
         "ACE",
         "ACM",
         "ACV",
         "ACX",
         "ADT",
         "APP",
         "ASD",
         "ASP",
         "ASX",
         "AVB" 
      ],
      "isSuccessful" : true,
      "isVirusScanEnabled" : true,
      "mode" : "ICAP",
      "scanServers" : [
         {
            "enabled" : true,
            "hostName" : "172.27.250.222",
            "ipAddress" : "172.27.250.222",
            "port" : 1344,
            "scanStatus" : 0,
            "serviceName" : "AVSCANRESP"
         },
         {
            "enabled" : true,
            "hostName" : "172.27.250.224",
            "ipAddress" : "172.27.250.224",
            "port" : 1344,
            "scanStatus" : 0,
            "serviceName" : "AVSCANRESP"
         }
      ]
  }
}