Querying the Server List of a Specified Middleware_Asset Management_API Description_API Reference (Ally Region)

Function

This API is used to query the server list of a specified middleware. You can query the middleware server list by its middleware name.

URI

GET /v5/{project_id}/asset/midwares/detail

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.
file_name	Yes	String	File name
category	No	String	Type. Its value can be: host container
host_name	No	String	Server name
host_ip	No	String	Server IP address
limit	No	Integer	Number of records on each page
offset	No	Integer	Offset, which specifies the start position of the record to be returned.
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 token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total
data_list	Array of JarPackageHostInfo objects	Server list

**Table 5** JarPackageHostInfo
Parameter	Type	Description
agent_id	String	Agent ID
host_id	String	Server ID
host_name	String	Server name
host_ip	String	Server IP address
file_name	String	JAR package name
name	String	JAR package name (without suffix)
catalogue	String	JAR package type
file_type	String	JAR package suffix
version	String	JAR package version
path	String	JAR package path
hash	String	JAR package hash
size	Integer	JAR package size
uid	Integer	uid
gid	Integer	gid
mode	String	File permissions
pid	Integer	Process ID
proc_path	String	Process executable file path
container_id	String	Container instance ID
container_name	String	Container name
package_path	String	Package path
is_embedded	Integer	Whether to display a nested package
record_time	Long	Scan time

Example Requests

The first 10 servers whose middleware name is log4j-core-2.8.2.jar and type is host are queried by default.

GET https://{endpoint}/v5/{project_id}/asset/midwares/detail?file_name=log4j-core-2.8.2.jar&category=host

Example Responses

Status code: 200

Request succeeded.

{
  "data_list" : [ {
    "agent_id" : "2d0fe7824005bf001220ad9d892e86f8af44a7d3608dab11165008ce439d3583",
    "catalogue" : "util",
    "container_id" : "",
    "file_name" : "rt.jar",
    "file_type" : "jar",
    "gid" : 0,
    "hash" : "04bf14e3b1da55d95561ca78cb29caa909410051dbe047e91ad6f5c1dedb8d6d",
    "host_id" : "103ed820-62e5-4754-b0f8-3e47b6dd49d2",
    "host_ip" : "192.168.1.76",
    "host_name" : "Do not delete the test.",
    "mode" : "-rw-------",
    "name" : "Java Runtime Environment",
    "path" : "/CloudResetPwdUpdateAgent/depend/jre/lib/rt.jar",
    "pid" : 1614,
    "proc_path" : "/CloudResetPwdUpdateAgent/depend/jre/bin/java",
    "record_time" : 1690513169986,
    "uid" : 0,
    "version" : "1.8.0_252",
    "size" : 128,
    "container_name" : "aaaa",
    "package_path" : "/CloudResetPwdUpdateAgent/depend/jre/bin/java",
    "is_embedded" : 0
  } ],
  "total_num" : 1
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Querying the Server List of a Specified Middleware