Querying the Server List of the Software

Function

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

URI

GET /v5/{project_id}/asset/apps

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Table 2 Query Parameters
Parameter	Mandatory	Type	Description
host_id	No	String	Server ID
host_name	No	String	Server name
app_name	No	String	Software name
host_ip	No	String	Server IP address
version	No	String	Software version
install_dir	No	String	Installation directory
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.
limit	No	Integer	Number of records on each page
offset	No	Integer	Offset, which specifies the start position of the record to be returned.
category	No	String	Type. The default value is host. The options are as follows: host container
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	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 a user token.

Response Parameters

Status code: 200

Table 4 Response body parameters
Parameter	Type	Description
total_num	Integer	Total software
data_list	Array of AppResponseInfo objects	Software list

Table 5 AppResponseInfo
Parameter	Type	Description
agent_id	String	Agent ID
host_id	String	Server ID
host_name	String	Server name
host_ip	String	Server IP address
app_name	String	Software name
version	String	Version number
update_time	Long	Latest update time, in milliseconds.
recent_scan_time	Long	Latest scanning time, in milliseconds.
container_id	String	Container ID
container_name	String	Container name

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

Request succeeded.

{
  "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"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent topic: Asset Management

Предыдущая статья

Querying the Open Port List of a Single Server

Следующая статья

Querying the Service List of Auto-Started Items

Была ли эта статья полезна?

Поддержка Юридические документы