Querying the List of Servers with a Specified Web Framework

Function

This API is used to query the list of servers with a specified web framework.

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/host/web-framework

**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	No	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 The default value is 0.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
category	Yes	String	Definition Asset Type Constraints N/A Range host: server asset container: container asset Default Value host
file_name	No	String	Definition File name. Constraints N/A Range Length: 1 to 256 characters Default Value N/A
host_name	No	String	Definition Server name. Constraints N/A Range It can contain 0 to 64 characters. Default Value N/A
host_ip	No	String	Definition Server IP address. Constraints N/A Range It can contain 0 to 64 characters. Default Value N/A
part_match	No	Boolean	Definition Whether fuzzy match is used. The default value is false. Constraints N/A Range true: fuzzy match false: exact match Default Value false

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
total_num	Integer	Definition Total number. Range Minimum value: 0; maximum value: 10000
data_list	Array of WebFrameworkHostInfo objects	Definition Server list. Range Minimum value: 0; maximum value: 10,000

**Table 5** WebFrameworkHostInfo
Parameter	Type	Description
agent_id	String	Definition agent id Range The value can contain 1 to 64 characters.
host_id	String	Definition Host ID. Range Length: 1 to 64 characters
host_name	String	Definition Server name. Range The value can contain 1 to 64 characters.
host_ip	String	Definition Server IP Address Range The value can contain 1 to 64 characters.
name	String	Definition Web framework name. Range Length: 1 to 256 characters
version	String	Definition Web framework version. Range Length: 1 to 512 characters
path	String	Definition Web framework file path. Range Length: 1 to 512 characters
record_time	Long	Definition Web framework scan time. Range Minimum value: 0; maximum value: 2^63-1
catalogue	String	Definition Software type. Range The value can contain 1 to 32 characters.
file_name	String	Definition Web framework file name. Range Length: 1 to 256 characters
file_type	String	Definition Web framework file type. Range Length: 1 to 32 characters
gid	Integer	Definition GID of the web framework process Range Minimum value: 0; maximum value: 2147483647
hash	String	Definition Web framework file hash. Range Length: 1 to 64 characters
is_embedded	Integer	Definition Whether the file is compressed Range 0: not compressed 1: compressed file
mode	String	Definition Web framework file permission. Range Length: 1 to 32 characters
pid	Integer	Definition PID of the web framework process Range Minimum value: 0; maximum value: 2147483647
proc_path	String	Definition Path of the web framework process. Range Length: 1 to 1024 characters
uid	Integer	Definition UID of the web framework process. Range Minimum value: 0; maximum value: 2147483647
container_id	String	Definition Container ID Range Length: 1 to 128 characters
container_name	String	Definition Container name Range Length: 1 to 256 characters

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "agent_id" : "9c2fbac4da71cd3398505bab80659db4ba1d203941d3da25cdfb3677376cd096",
    "catalogue" : "web-framework",
    "container_id" : "",
    "file_name" : "fastjson-1.2.83.jar",
    "file_type" : "jar",
    "hash" : "641a4d65ab32fbfdccd9c718e3f83ebc4caabdb5e4fe5b3d51527c5fe692631d",
    "host_id" : "c86852db-67e1-3684-89ce-e44da0de1398",
    "host_ip" : "10.112.30.130",
    "host_name" : "DESKTOP-IR68FI4",
    "name" : "fastjson",
    "path" : "C:\\Users\\w30074977\\AppData\\Roaming\\JetBrains\\IntelliJIdea2024.1\\plugins\\HWPluginStore\\lib\\fastjson-1.2.83.jar",
    "pid" : 25320,
    "proc_path" : "D:\\IntelliJ IDEA 2024.1.4\\bin\\idea64.exe",
    "record_time" : 1743523314802,
    "version" : "1.2.83"
  } ]
}