Help Center/ Host Security Service/ API Reference/ API Description/ Asset Management/ Asset Management - Asset Fingerprint - WebAppAndService Asset Information on the Right
Updated on 2025-08-15 GMT+08:00

Asset Management - Asset Fingerprint - WebAppAndService Asset Information on the Right

Function

Asset management - asset fingerprint - WebAppAndService asset information on the right

Calling Method

For details, see Calling APIs.

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

Parameter description:

Number of records displayed on each page.

Constraints:

N/A

Options:

Value range: 10-200

Default value:

10

name

Yes

String

WebAppAndService asset name

category

Yes

String

Returned asset category. The options are as follows:

  • 0: host

  • 1: container

catalogue

Yes

String

Asset type.

  • web-app: web application

  • web-service: web service

  • database: database

host_name

No

String

(Optional) Server name. You can search for a server by name.

host_id

No

String

(Optional) Server ID. You can search for a server by ID.

host_ip

No

String

(Optional) Server IP address. You can search for a server by IP address.

version

No

String

WebAppAndService asset version. You can search for assets by version.

install_dir

No

String

WebAppAndService asset installation directory. You can search for assets by installation directory.

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

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

Total

data_list

Array of WebAppAndServiceResponseInfo objects

Hosts with the WebAppAndService asset and the asset information list

Table 5 WebAppAndServiceResponseInfo

Parameter

Type

Description

catalogue

String

Asset Fingerprint Type

name

String

Asset Fingerprint Name

version

String

Asset fingerprint-Database-Version

agent_id

String

agent_id

install_path

String

Installation path.

config_path

String

Configuration file path.

uid

Integer

uid

gid

Integer

gid

mode

String

mode

ctime

Long

ctime

mtime

Long

mtime

atime

Long

atime

pid

Integer

pid

proc_path

String

proc_path

container_id

String

container_id

container_name

String

container_name

record_time

Long

record_time

host_name

String

host_name

host_id

String

host_id

host_ip

String

host_ip

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

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
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 ListWebAppAndServicesSolution {

    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");
        String projectId = "{project_id}";

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

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        ListWebAppAndServicesRequest request = new ListWebAppAndServicesRequest();
        try {
            ListWebAppAndServicesResponse response = client.listWebAppAndServices(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
# 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = ListWebAppAndServicesRequest()
        response = client.list_web_app_and_services(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
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")
    projectId := "{project_id}"

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

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

    request := &model.ListWebAppAndServicesRequest{}
	response, err := client.ListWebAppAndServices(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

Request succeeded.

Error Codes

See Error Codes.