Help Center/ Host Security Service/ API Reference/ API Description/ Antivirus/ Exporting the Virus Scan Result List
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Exporting the Virus Scan Result List

Function

This API is used to export the virus scan result list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v5/{project_id}/antivirus/result/export

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

offset

Yes

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

N/A

limit

Yes

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10 to 200

Default Value

10

host_name

No

String

Definition

Server name.

Constraints

N/A

Range

The value contains 1 to 256 characters.

Default Value

N/A

private_ip

No

String

Definition

Server private IP address.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

public_ip

No

String

Definition

Server EIP.

Constraints

N/A

Range

For IPv4, the value contains 7 to 15 characters. For IPv6, the value contains 15 to 39 characters.

Default Value

None

handle_status

No

String

Definition

Handling Status

Constraints

N/A

Range

Its value can be:

  • unhandled

  • handled

Default Value

N/A

severity_list

No

Array of strings

Definition

Risk level. It has been deprecated.

Constraints

N/A

Range

Threat level. The options are as follows:

  • Low

  • Medium

  • High

  • Critical

Default Value

N/A

severities

No

String

Threat level. The options are as follows:

  • Low

  • Medium

  • High

  • Critical

asset_value

No

String

Definition

Asset importance.

Constraints

N/A

Range

  • important

  • common

  • test

Default Value

None

malware_name

No

String

Definition

Virus Name

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

file_path

No

String

Definition

File path.

Constraints

N/A

Range

The value contains 1 to 512 characters.

Default Value

N/A

export_size

No

Integer

Exported records

file_hash

No

String

Definition

File hash. The current value is sha256.

Constraints

The value must be a valid SHA-256 hash value.

Range

The value contains 64 characters.

Default Value

N/A

task_name

No

String

Definition

Task

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

manual_isolate

No

Boolean

Definition

Whether the manual isolation button is used.

Constraints

N/A

Range

true (manual isolation is used) or false (manual isolation is not used)

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

export_headers

No

Array<Array<String>>

Export table header set

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

task_id

String

Export task ID

Example Requests

Header list of the exported table.

{
  "export_headers" : [ [ "malware_name", "Virus Name" ], [ "file_path", "Virus File Path" ], [ "severity", "Virus Level" ], [ "malware_type", "Virus Type" ], [ "host_name", "Affected Server Name" ], [ "host_id", "Server ID" ], [ "private_ip", "Private IP Address" ], [ "public_ip", "EIP" ], [ "occur_time", "Last Detected" ], [ "handle_method", "Status" ] ]
}

Example Responses

Status code: 200

Virus scan and removal events

{
  "task_id" : "9e8***4-d26b-426d-a2be-765930242984"
}

Status Codes

Status Code

Description

200

Virus scan and removal events

Error Codes

See Error Codes.

Parent Topic: Antivirus