Help Center/ Host Security Service/ API Reference/ API Description/ Application Process Control/ Querying the Processes Identified by the Process Whitelist Policy
Updated on 2025-08-15 GMT+08:00

Querying the Processes Identified by the Process Whitelist Policy

Function

This API is used to query the processes identified by the process whitelist policy.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/app/{policy_id}/process

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

policy_id

Yes

String

Definition

Policy ID.

Constraints

Mandatory.

Range

The value can contain 1 to 64 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

process_status

No

String

Definition

Trust status.

Constraints

N/A

Range

  • trust

  • suspicious

  • malicious

  • unknown

Default Value

N/A

process_type

No

String

Definition

Process type.

Constraints

N/A

Range

  • system: system program

  • interpretive: interpretive program

  • normal: common executable program

Default Value

N/A

process_name

No

String

Definition

Process name.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

process_hash

No

String

Definition

Process hash.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

process_path

No

String

Definition

Process path.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

handle_status

No

String

Definition

Confirmation status.

Constraints

N/A

Range

  • confirmed

  • unconfirmed

Default Value

N/A

os_type

No

String

OS type. Its value can be:

  • Linux

  • Windows

file_signer

No

String

Definition

File signature.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

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 AppWhitelistPolicyProcessResponseInfo objects

data list

total_num

Integer

Definition

Total number.

Range

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

Table 5 AppWhitelistPolicyProcessResponseInfo

Parameter

Type

Description

process_name

String

Definition

Process name.

Range

The value can contain 1 to 128 characters.

process_path

String

Definition

Process path.

Range

The value can contain 1 to 256 characters.

process_hash

String

Process hash

handle_status

String

Definition

Handling method.

Range

  • confirmed

  • unconfirmed

specified_path

String

Definition

Specified directory.

Range

The value can contain 1 to 512 characters.

cmdline

String

Definition

Process command line.

Constraints

N/A

file_size

Integer

Definition

File size.

Constraints

N/A

Range

The value range is 0 to 9,223,372,036,854,775,807.

Default Value

N/A

file_signer

String

Definition

File signature.

Range

The value can contain 1 to 128 characters.

process_type

Integer

Definition

Process type.

Constraints

N/A

Range

  • 1*: system program

  • 2: interpretive program

  • 3: common executable program

os_type

String

Definition

OS type.

Range

  • Linux

  • Windows

app_type

String

Definition

Application type.

Constraints

N/A

whitelist_count

Integer

Definition

Whitelist confirmation count

Constraints

N/A

blacklist_count

Integer

Definition

Blacklist confirmation count

Constraints

N/A

trust_status_source

Integer

Definition

Process trust status.

Constraints

N/A

Range

  • 0: intelligence

  • 1: malware

  • 2: manual confirmation

  • 3: self-learning

Default Value

N/A

process_status

String

Definition

Process trust status.

Constraints

N/A

Range

  • trust

  • suspicious

  • malicious

  • unknown

Default Value

N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 10,
  "data_list" : [ {
    "process_name" : "",
    "process_path" : "",
    "process_hash" : "",
    "process_status" : "trust",
    "handle_status" : "confirmed",
    "specified_path" : "",
    "file_path" : "",
    "container_id" : "",
    "cmdline" : "",
    "file_size" : 2147483647,
    "file_signer" : "",
    "process_type" : "system",
    "os_type" : "",
    "app_type" : "",
    "whitelist_count" : 2147483647,
    "blacklist_count" : 2147483647
  } ]
}

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

    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();
        ListAppWhitelistPolicyProcessRequest request = new ListAppWhitelistPolicyProcessRequest();
        request.withPolicyId("{policy_id}");
        try {
            ListAppWhitelistPolicyProcessResponse response = client.listAppWhitelistPolicyProcess(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
# 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 = ListAppWhitelistPolicyProcessRequest()
        request.policy_id = "{policy_id}"
        response = client.list_app_whitelist_policy_process(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
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.ListAppWhitelistPolicyProcessRequest{}
	request.PolicyId = "{policy_id}"
	response, err := client.ListAppWhitelistPolicyProcess(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.