Querying the Server List of the Software

Function

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

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/apps

**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
host_id	No	String	Definition Unique ID of a server. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
host_name	No	String	Definition Server name. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A
app_name	No	String	Definition Software name. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A
host_ip	No	String	Definition Server IP address Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A
version	No	String	Definition Software version. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
install_dir	No	String	Definition Installation directory. Constraints N/A Range The value can contain 0 to 512 characters. Default Value N/A
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.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
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.
category	No	String	Definition Type. Constraints N/A Range host container Default Value N/A
part_match	No	Boolean	Definition Whether fuzzy match is used. Constraints Boolean type. Range N/A 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
total_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.
data_list	Array of AppResponseInfo objects	Definition Software list. Range The value range is 0 to 10,000.

**Table 5** AppResponseInfo
Parameter	Type	Description
agent_id	String	Definition agent ID Range N/A
host_id	String	Definition Server IDs. Range N/A
host_name	String	Definition Server Name Range N/A
host_ip	String	Definition Server IP address Range N/A
app_name	String	Definition Software name. Range N/A
version	String	Definition Software version Range N/A
install_dir	String	Definition Software installation path Range N/A
container_id	String	Definition Container ID. Range N/A
container_name	String	Definition Container name Range N/A
recent_scan_time	Long	Definition Last scan time. Range N/A
update_time	Long	Definition Update time. Range N/A

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