Help Center/ Host Security Service/ API Reference/ API Description/ Asset Management/ Querying the Asset Fingerprint Collection Status of a Single Server
Updated on 2026-04-03 GMT+08:00

Querying the Asset Fingerprint Collection Status of a Single Server

Function

This API is used to query the asset fingerprint collection status of a single server.

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}/asset/manual-collect/{type}

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

type

Yes

String

Definition

Resource type.

Constraints

N/A

Range

  • web-app: web application

  • web-service: web service

  • web-framwork: web framework

  • web-site: website

  • midware: middleware

  • database: database

  • kernel-module: kernel module

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.

host_id

Yes

String

Definition

Server ID

Constraints

N/A

Range

The value can contain 1 to 256 characters.

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

scan_status

String

Definition

Linux System

Range

  • neverscan: never scanned

  • scanning: scanning

  • scanned: The scan is complete.

  • failed: The scan failed.

  • longscanning: The scan timed out.

scanned_time

Long

Definition

Time when the check was completed.

Range

Minimum value: 0; maximum value: 2^63-1

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "scan_status" : "scanned",
  "scanned_time" : 1743609707401
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.