Help Center/Host Security Service/API Reference/API Description/Event Management/Querying Export Tasks
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying Export Tasks

Function

This API is used to query export tasks.

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

GET /v5/{project_id}/export-task/{task_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Task ID.

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

ID of the enterprise project that a server belongs.

An enterprise project can be configured only after the enterprise project function is enabled.

Enterprise project ID. The value 0 indicates the default enterprise project. To query servers in all enterprise projects, set this parameter to all_granted_eps. If you have only the permission on an enterprise project, you need to transfer the enterprise project ID to query the server in the enterprise project. Otherwise, an error is reported due to insufficient permission.

Request Parameters

Table 3 Request header 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 the user token.

region

No

String

Region ID

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

task_id

String

Definition

Task ID

Range

Length: 1 to 64 characters

task_name

String

Definition

Task Name

Range

The value can contain 1 to 128 characters.

task_status

String

Definition

Status of the export task.

Range

  • success

  • failure

  • running: The task is being executed.

file_id

String

Definition

File ID.

Range

The value can contain 1 to 64 characters.

file_name

String

Definition

File Name

Range

The value can contain 1 to 255 characters.

Example Requests

Query the ID, status, and name of an export task based on the task_id.

GET https://{endpoint}/v5/{project_id}/export-task/{task_id}?enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "task_id" : "94ad7efb-xxxxx-46ed-99bf-dcd8c1c75dc2",
  "task_name" : "vul_vul_xxxxxxx_export_task",
  "task_status" : "success",
  "file_id" : "b3e83d25-d92f-4963-a293-e056e81ec44d",
  "file_name" : "hss-vul-vul-zh-xxxxxxxx.zip"
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Event Management