Querying the Server List of a Web Service, Web Application, or Database

Function

This API is used to query the server list of a web service, web application, or database.

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/web-app-and-services

**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
name	No	String	Definition Web application, web service, or database name Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
catalogue	Yes	String	Definition Asset Type Constraints N/A Range web-app: web application web-service: web service database: database Default Value N/A
host_name	No	String	Definition (Optional) Server name. You can search for a server by name. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
host_id	No	String	Definition (Optional) Server ID. You can search for a server by ID. Constraints N/A Range It can contain 0 to 64 characters. Default Value N/A
host_ip	No	String	Definition (Optional) Server IP address. You can search for a server by IP address. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
version	No	String	Definition Web application, web service, or database version, which can be searched by version Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
install_dir	No	String	Definition Installation directory of the web application, web service, or database. Users can search for the web application, web service, or database based on the installation directory. Constraints N/A Range The value can contain 0 to 256 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: 300,000
data_list	Array of WebAppAndServiceResponseInfo objects	Definition Servers with the web application, web service, and database assets and the asset information list Range Minimum value: 0; maximum value: 10,000

**Table 5** WebAppAndServiceResponseInfo
Parameter	Type	Description
catalogue	String	Definition Fingerprint types of web applications, web services, and database assets Range It can contain 0 to 64 characters.
name	String	Definition Asset Fingerprint Name Range It can contain 0 to 64 characters.
version	String	Definition Asset Fingerprint Version Range It can contain 0 to 64 characters.
agent_id	String	Definition agent id Range The value can contain 1 to 64 characters.
install_path	String	Definition Installation path. Range The value can contain 0 to 256 characters.
config_path	String	Definition Configuration file path. Range The value can contain 0 to 256 characters.
uid	Integer	Definition uid Range Minimum value: 0; maximum value: 2147483647
gid	Integer	Definition gid Range The value range is 0 to 2,147,483,647.
mode	String	Definition Asset fingerprint file permission. Range The value can contain 1 to 32 characters.
ctime	Long	Definition Last status change time of an asset fingerprint file. Range Minimum value: 0; maximum value: 2^63-1
mtime	Long	Definition Last modification time of an asset fingerprint file. Range Minimum value: 0; maximum value: 2^63-1
atime	Long	Definition Last access time of an asset fingerprint file. Range Minimum value: 0; maximum value: 2^63-1
pid	Integer	Definition pid Range The value range is 0 to 2,147,483,647.
proc_path	String	Definition Asset fingerprint process path Range The value can contain 0 to 256 characters.
container_id	String	Definition Container ID. Range The value can contain 0 to 256 characters.
container_name	String	Definition Container name. Range The value can contain 0 to 256 characters.
record_time	Long	Definition Asset fingerprint scan time. Range Minimum value: 0; maximum value: 2^63-1
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.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "catalogue" : "database",
    "name" : "mysql",
    "version" : "5.7.22",
    "agent_id" : "64cdb070d5497fa64b1482ce5d91580006615f20eb373d7377ad6f34015ce49f",
    "install_path" : "/usr/sbin",
    "config_path" : "/etc/my.cnf",
    "uid" : 0,
    "gid" : 0,
    "mode" : "dr-xr-xr-x",
    "ctime" : 1739346659,
    "mtime" : 1739346659,
    "atime" : 1743392605,
    "pid" : 1310,
    "proc_path" : "/usr/sbin/mysqld",
    "container_id" : "",
    "container_name" : "",
    "record_time" : 1743972146053,
    "host_name" : "test-lmh-005",
    "host_id" : "44ba96ad-91e4-40d7-9f51-34f999755712",
    "host_ip" : "192.168.0.77"
  } ]
}