Help Center/ Host Security Service/ API Reference/ API Description/ Vulnerability Management/ Creating a Task for Exporting Vulnerability Handling Records
Updated on 2026-04-03 GMT+08:00

Creating a Task for Exporting Vulnerability Handling Records

Function

This API is used to create a task for exporting vulnerability handling records.

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}/vulnerability/handle-history/export-task

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.

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

status

No

String

Vulnerability status.

vul_status_unfix: not processed

vul_status_ignored: ignored

vul_status_verified: The verification is in progress.

vul_status_fixing: The VM is being repaired.

vul_status_fixed: The repair is successful.

vul_status_reboot: The repair is successful and the system is to be restarted.

vul_status_failed: The repair fails.

vul_status_fix_after_reboot :: Restart the host and rectify the fault again.

vul_id

No

String

Vulnerability ID.

vul_type

No

String

Vulnerability type. The options are as follows:

-linux_vul: Linux vulnerability

-windows_vul: Windows vulnerability

-web_cms: Web-CMS vulnerability

-app_vul: application vulnerability

-urgent_vul: emergency vulnerability

asset_value

No

String

Asset importance. Its value can be:

important

common

test

group_name

No

String

Server group

host_name

No

String

Server name

host_ip

No

String

Server IP address

export_size

No

Integer

Number of exported data records.

export_header_list

Yes

Array<Array<String>>

List of table headers for exporting vulnerability data

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

task_id

String

Export task ID

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "task_id" : "xxx"
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.