Help Center/ Host Security Service/ API Reference/ API Description/ Asset Management/ Creating a Global Asset Scan Task
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Creating a Global Asset Scan Task

Function

This API is used to create a global asset scan task.

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}/asset/assign-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.

category

Yes

String

Definition

Asset Type

Constraints

N/A

Range

  • host: server asset

  • container: container asset

Default Value

host

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

host_ids

No

Array of strings

Definition

List of servers that deliver tasks.

Constraints

N/A

Range

The value range is 0 to 200.

Default Value

N/A

server_group

No

Array of strings

Definition

List of server groups that deliver tasks.

Constraints

N/A

Range

The value range is 0 to 200.

Default Value

N/A

all_hosts

No

Boolean

Definition

Delivers the scan of all servers.

Constraints

N/A

Range

  • true: All servers are scanned.

  • false: Do not scan all servers.

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

error

String

Definition

Failure cause.

Range

The value can contain 1 to 256 characters.

Example Requests

Create a global asset scan task and query the status of the global scan task of the server whose project_id is 2b31ed520xxxxxxebedb6e57xxxxxxxx.

POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/asset/assign-task?enterprise_project_id=all_granted_eps&category=host

{
  "all_hosts" : true
}

Example Responses

Status code: 200

Request succeeded.

{
  "error" : "84b5266c14ae489fa6549827f032dc62-all_granted_eps processed 1 tasks successfully."
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Asset Management