Asset Fingerprint of a Server - Software¶

Function¶

This API is used to check software information in the asset fingerprints of a server.

URI¶

GET /v5/{project_id}/asset/apps

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	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 token. 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	Software version Minimum: 0 Maximum: 128
install_dir	No	String	Installation directory Minimum: 0 Maximum: 512
enterprise_project_id	No	String	Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. Default: 0 Minimum: 1 Maximum: 256
limit	No	Integer	Number of records on each page. Minimum: 10 Maximum: 100 Default: 10
offset	No	Integer	Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 10000 Default: 0

Request Parameters¶

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Minimum: 32 Maximum: 4096

Response Parameters¶

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
total_num	Integer	Total software 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	Latest update time, in milliseconds. Minimum: 0 Maximum: 2147483647
recent_scan_time	Long	Last scanned, in ms. Minimum: 0 Maximum: 2147483647

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

Status Codes¶

Status Code	Description
200	Applications installed on a host

Error Codes¶

See Error Codes.

last updated: 2024-09-09 12:47 UTC - commit: 862430799322a6499439e49940ea5739b41ea7c6