All Products
Search
Document Center

Security Center:GetFileDetectResult

Last Updated:Nov 30, 2022

Obtains the file detection results.

Operation Description

The HashKey parameter is included in all API operations that are related to the file detection feature. The parameter specifies the unique identifier of a file. Only MD5 hash values are supported. Before you call this operation, calculate the MD5 hash value of the file.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
yundun-sas:GetFileDetectResultRead
  • SecurityCenter
    acs:yundun-sas:*:{#accountId}:*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

183.46.XX.XX
HashKeyListarrayYes

An array that consists of the identifiers of files. Only MD5 hash values are supported.

stringNo

The identifier of the file. Only MD5 hash values are supported.

0a212417e65c26ff133cfff28f9c****
TypeintegerYes

The type of the file. Valid values:

  • 0: unknown file
  • 1: binary file
  • 2: webshell file
  • 4: script file
NoteIf you do not know the type of the file, set this parameter to 0.
0

Response parameters

ParameterTypeDescriptionExample
object

The returned message.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

24A20733-10A0-4AF6-BE6B-E3322413BB68
ResultListarray

An array that consists of file detection results.

object

The information about the file detection result.

HashKeystring

The identifier of the file. Only MD5 hash values are supported.

0a212417e65c26ff133cfff28f6c****
Resultinteger

The file detection result. Valid values:

  • 0: normal file.
  • 1: suspicious file.
  • 3: The detection is in progress.
0
Scoreinteger

The score of file detection result.

NoteA higher score indicates a more suspicious file.
100
VirusTypestring

The type of virus. Valid values:

  • Trojan: self-mutating trojan
  • WebShell: webshell
  • Backdoor: backdoor program
  • RansomWare: ransomware
  • Scanner: scanner
  • Stealer: tool that is used to steal information
  • Malbaseware: tainted basic software
  • Hacktool: attacker tool
  • Engtest: engine test program
  • Downloader: trojan downloader
  • Virus: infectious virus
  • Miner: mining program
  • Worm: worm
  • DDoS: DDoS trojan
  • Malware: malicious program
  • Backdoor: reverse shell
  • RiskWare: software that has risks
  • Proxytool: proxy
  • Suspicious: suspicious program
  • MalScript: malicious script
  • Rootkit: rootkit
  • Exploit: exploit
WEBSHELL
Codestring

The status code returned. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.

200
Messagestring

The error message returned.

successful
Extstring

The extended information about the file detection result.

{"HighLight":[[23245,23212]]}

Example

Normal return example

JSONFormat

{
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413BB68",
  "ResultList": [
    {
      "HashKey": "0a212417e65c26ff133cfff28f6c****",
      "Result": 0,
      "Score": 100,
      "VirusType": "WEBSHELL",
      "Code": "200",
      "Message": "successful",
      "Ext": "{\"HighLight\":[[23245,23212]]}"
    }
  ]
}

Error codes

Http codeError codeError message
400RequestTooFrequentlyRequest too frequently, please try again later
400GetResultFailGet result fail, found no detect record for this file or result has been expired
400InvalidApiDetectTypeUnsupported Api Detect Type.
403NoPermissioncaller has no permission
500ServerErrorServerError
500SystemBusySystem busy, please try again later.

For a list of error codes, visit the API error center.