Help Center/ Host Security Service/ API Reference/ API Description/ Application Process Control/ Querying the Servers Associated with a Process Whitelist Policy
Updated on 2025-08-15 GMT+08:00

Querying the Servers Associated with a Process Whitelist Policy

Function

This API is used to query the servers associated with a process whitelist policy.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/app/host

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

Yes

String

ID of the enterprise project that a server belongs.

An enterprise project can be configured only after the enterprise project function is enabled.

Enterprise project ID. The value 0 indicates the default enterprise project. To query servers in all enterprise projects, set this parameter to all_granted_eps. If you have only the permission on an enterprise project, you need to transfer the enterprise project ID to query the server in the enterprise project. Otherwise, an error is reported due to insufficient permission.

offset

Yes

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

N/A

limit

Yes

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10 to 200

Default Value

10

policy_name

No

String

Policy name

learning_status

No

String

Definition

Policy learning status.

Constraints

N/A

Range

  • effecting: The learning is complete, and the policy has been applied.

  • learned: The learning is complete, and the results are to be confirmed.

  • learning: The learning is in progress.

  • pause: paused

  • abnormal: The learning is abnormal.

Default Value

N/A

apply_status

No

Boolean

Definition

Policy application status.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

asset_value

No

String

Asset importance. The options are as follows:

  • important

  • common

  • test

host_name

No

String

Definition

Server name.

Constraints

N/A

Range

The value contains 1 to 256 characters.

Default Value

N/A

private_ip

No

String

Definition

Server private IP address.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

os_type

No

String

OS type. Its value can be:

  • Linux

  • Windows

policy_id

No

String

Policy ID

public_ip

No

String

Server public IP address

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

data_list

Array of AppWhitelistPolicyHostResponseInfo objects

data list

total_num

Integer

Definition

Total number.

Range

The value range is 0 to 2,147,483,647.

Table 5 AppWhitelistPolicyHostResponseInfo

Parameter

Type

Description

host_id

String

Definition

Server ID.

Range

The value can contain 1 to 64 characters.

host_name

String

Definition

Server name.

Range

The value can contain 1 to 256 characters.

public_ip

String

Definition

EIP.

Range

The value can contain 1 to 256 characters.

private_ip

String

Definition

Server private IP address.

Range

The value can contain 1 to 128 characters.

asset_value

String

Asset importance. Its value can be:

  • important

  • common

  • test

policy_name

String

Policy name

event_num

Integer

Definition

Number of events on a server.

Range

The value range is 0 to 2,147,483,647.

os_type

String

Definition

OS type.

Range

  • Linux

  • Windows

learning_status

String

Definition

Server name.

Constraints

N/A

Range

  • effecting: The learning is complete, and the policy has been applied.

  • learned: The learning is complete, and the results are to be confirmed.

  • learning: The learning is in progress.

  • pause: paused

  • abnormal: The learning is abnormal.

Default Value

N/A

apply_status

Boolean

Definition

Apply or not.

Range

  • true: Yes

  • false: No

intercept

Boolean

Block or not

policy_id

String

Policy ID

policy_type

String

Policy type

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 10,
  "data_list" : [ {
    "host_id" : "bdcb6303b37c613427****73e0024864019eaf982f30c9384db",
    "host_name" : "host name",
    "public_ip" : "127.0.0.1",
    "private_ip" : "127.0.0.1",
    "asset_value" : "important",
    "policy_name" : "policy name",
    "abnormal_handle_mode" : "alarm_only",
    "event_num" : 10,
    "os_type" : "Linux",
    "learning_status" : "effecting",
    "apply_status" : true
  } ]
}

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

    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();
        ListAppWhitelistPolicyHostRequest request = new ListAppWhitelistPolicyHostRequest();
        try {
            ListAppWhitelistPolicyHostResponse response = client.listAppWhitelistPolicyHost(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 = ListAppWhitelistPolicyHostRequest()
        response = client.list_app_whitelist_policy_host(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.ListAppWhitelistPolicyHostRequest{}
	response, err := client.ListAppWhitelistPolicyHost(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.