Querying the Server List of the Software

Function

This API is used to query the server list of the software.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/asset/apps

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID Minimum: 1 Maximum: 256

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
host_id	Yes	String	Server ID Minimum: 0 Maximum: 128
host_name	No	String	Server name Minimum: 0 Maximum: 128
app_name	No	String	Software name Minimum: 0 Maximum: 128
host_ip	No	String	Server IP address Minimum: 0 Maximum: 128
version	No	String	Version number Minimum: 0 Maximum: 128
install_dir	No	String	Installation directory Minimum: 0 Maximum: 512
enterprise_project_id	No	String	Enterprise project Minimum: 1 Maximum: 256
limit	No	Integer	Default value: 10 Minimum: 10 Maximum: 100 Default: 10
offset	No	Integer	Default value: 0 Minimum: 0 Maximum: 10000 Default: 0
category	No	String	Type. The default value is host. The options are as follows: host container Minimum: 0 Maximum: 64
part_match	No	Boolean	Whether fuzzy match is used. The default value is false.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	iam token Minimum: 32 Maximum: 4096

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total number Minimum: 0 Maximum: 10000
data_list	Array of AppResponseInfo objects	Software list Array Length: 0 - 10000

**Table 5** AppResponseInfo
Parameter	Type	Description
agent_id	String	agent_id Minimum: 0 Maximum: 128
host_id	String	Server ID Minimum: 1 Maximum: 128
host_name	String	Server name Minimum: 1 Maximum: 256
host_ip	String	Server IP address Minimum: 1 Maximum: 256
app_name	String	Software name Minimum: 1 Maximum: 128
version	String	Version number Minimum: 1 Maximum: 128
update_time	Long	Update time Minimum: 0 Maximum: 2147483647
recent_scan_time	Long	Latest scan time Minimum: 0 Maximum: 2147483647
container_id	String	Container ID Minimum: 1 Maximum: 128
container_name	String	Container name Minimum: 1 Maximum: 256

Example Requests

The first 10 servers whose software name is ACL are queried by default.

GET https://{endpoint}/v5/{project_id}/asset/apps?app_name=acl

Example Responses

Status code: 200

Applications installed on a host

{
  "total_num" : 1,
  "data_list" : [ {
    "agent_id" : "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8",
    "host_id" : "55dac7fe-d81b-43bc-a4a7-4710fe673972",
    "host_name" : "xxxx",
    "host_ip" : "192.168.0.126",
    "app_name" : "acl",
    "version" : "2.2.51-14.eulerosv2r7",
    "update_time" : 1668150671981,
    "recent_scan_time" : 1668506044147,
    "container_id" : "ce794b8a6071f5fd7e4d142dab7b36bedf2c7a4f6083fb82e5bbc82709b50018",
    "container_name" : "hss_imagescan_W73V1WO6"
  } ]
}