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

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.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Minimum: 20

Maximum: 64

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.

Minimum: 0

Maximum: 64

file_name

Yes

String

File name

Minimum: 1

Maximum: 256

category

No

String

Type. Its value can be:

  • host

  • container

Minimum: 0

Maximum: 64

host_name

No

String

Server name

Minimum: 0

Maximum: 64

host_ip

No

String

Server IP address

Minimum: 0

Maximum: 64

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: 300000

Default: 0

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.

Minimum: 32

Maximum: 2097152

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total

Minimum: 0

Maximum: 10000

data_list

Array of JarPackageHostInfo objects

Server list

Array Length: 0 - 10000

Table 5 JarPackageHostInfo

Parameter

Type

Description

agent_id

String

Agent ID

Minimum: 1

Maximum: 64

host_id

String

Server ID

Minimum: 0

Maximum: 128

host_name

String

Server name

Minimum: 0

Maximum: 256

host_ip

String

Server IP address

Minimum: 0

Maximum: 128

file_name

String

JAR package name

Minimum: 0

Maximum: 256

name

String

JAR package name (without suffix)

Minimum: 0

Maximum: 256

catalogue

String

JAR package type

Minimum: 0

Maximum: 32

file_type

String

JAR package suffix

Minimum: 0

Maximum: 32

version

String

JAR package version

Minimum: 0

Maximum: 64

path

String

JAR package path

Minimum: 0

Maximum: 512

hash

String

JAR package hash

Minimum: 0

Maximum: 512

size

Integer

JAR package size

Minimum: 0

Maximum: 2147483647

uid

Integer

uid

Minimum: 0

Maximum: 2147483647

gid

Integer

gid

Minimum: 0

Maximum: 2147483647

mode

String

File permissions

Minimum: 0

Maximum: 32

pid

Integer

Process ID

Minimum: 0

Maximum: 2147483647

proc_path

String

Process executable file path

Minimum: 0

Maximum: 1024

container_id

String

Container instance ID

Minimum: 0

Maximum: 128

container_name

String

Container name

Minimum: 0

Maximum: 256

package_path

String

Package path

Minimum: 0

Maximum: 1024

is_embedded

Integer

Whether to display a nested package

Minimum: 0

Maximum: 2147483647

record_time

Long

Scan time

Minimum: 0

Maximum: 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

ListJarPackageHostInfo

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

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;


public class ListJarPackageHostInfoSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        ListJarPackageHostInfoRequest request = new ListJarPackageHostInfoRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withFileName("<file_name>");
        request.withCategory("<category>");
        request.withHostName("<host_name>");
        request.withHostIp("<host_ip>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withPartMatch(<part_match>);
        try {
            ListJarPackageHostInfoResponse response = client.listJarPackageHostInfo(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListJarPackageHostInfoRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.file_name = "<file_name>"
        request.category = "<category>"
        request.host_name = "<host_name>"
        request.host_ip = "<host_ip>"
        request.limit = <limit>
        request.offset = <offset>
        request.part_match = <PartMatch>
        response = client.list_jar_package_host_info(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListJarPackageHostInfoRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	request.FileName = "<file_name>"
	categoryRequest:= "<category>"
	request.Category = &categoryRequest
	hostNameRequest:= "<host_name>"
	request.HostName = &hostNameRequest
	hostIpRequest:= "<host_ip>"
	request.HostIp = &hostIpRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	partMatchRequest:= <part_match>
	request.PartMatch = &partMatchRequest
	response, err := client.ListJarPackageHostInfo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

ListJarPackageHostInfo

Error Codes

See Error Codes.