Help Center/ Host Security Service/ API Reference/ API Description/ Asset Management/ Querying the Server List of a Specified Middleware
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying the Server List of a Specified Middleware

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.

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/midwares/detail

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.

file_name

Yes

String

Definition

File name.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

category

No

String

Definition

Type.

Constraints

N/A

Range

  • host

  • container

Default Value

N/A

host_name

No

String

Definition

Server name.

Constraints

N/A

Range

The value can contain 0 to 64 characters.

Default Value

N/A

host_ip

No

String

Definition

Server IP address.

Constraints

N/A

Range

The value can contain 0 to 64 characters.

Default Value

N/A

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.

part_match

No

Boolean

Definition

Whether fuzzy match is used.

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

Details:

Total number of servers containing the middleware

Range

The value contains 0 to 10,000 characters.

data_list

Array of JarPackageHostInfo objects

Definition

Server list.

Range

N/A
Table 5 JarPackageHostInfo

Parameter

Type

Description

agent_id

String

Details:

agent_id

Range

The value contains 1 to 64 characters.

host_id

String

Details:

Host ID.

Range

The value contains 0 to 128 characters.

host_name

String

Details:

Server name

Range

The value contains 0 to 256 characters.

host_ip

String

Details:

Server IP address

Range

The value contains 0 to 128 characters.

file_name

String

Definition

File name.

Range

The value can contain 0 to 256 characters.

name

String

Details:

Middleware package name (without the file name extension)

Range

The value contains 0 to 256 characters.

catalogue

String

Details:

Middleware package type

Range

The value contains 0 to 32 characters.

file_type

String

Definition

File type.

Range

The value can contain 0 to 32 characters.

version

String

Details:

Middleware package version

Range

The value contains 0 to 64 characters.

path

String

Details:

Middleware package path

Range

The value contains 0 to 512 characters.

hash

String

Details:

Middleware package hash

Range

The value contains 0 to 512 characters.

size

Integer

Details:

Middleware package size

Range

The value ranges from 0 to 2147483647.

uid

Integer

Details:

uid

Range

The value ranges from 0 to 2147483647.

gid

Integer

Details:

gid

Range

The value ranges from 0 to 2147483647.

mode

String

Details:

File Permissions

Range

The value contains 0 to 32 characters.

pid

Integer

Details:

Process ID.

Range

The value ranges from 0 to 2147483647.

proc_path

String

Details:

Path of the executable file of a process

Range

The value contains 0 to 1024 characters.

container_id

String

Details:

Container instance ID

Range

The value contains 0 to 128 characters.

container_name

String

Details:

Container Name

Range

The value contains 0 to 256 characters.

package_path

String

Details:

Package path

Range

The value contains 0 to 1024 characters.

is_embedded

Integer

Details:

Nested Package

Range

  • 0: not a nested package

  • 1: nested package

record_time

Long

Details:

Scanned On

Range

The value ranges from 0 to 4070880000000.

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.

Parent Topic: Asset Management