更新时间:2025-08-15 GMT+08:00

查询进程白名单策略列表

功能介绍

查询进程白名单策略列表

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/app/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

不涉及

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

policy_name

String

策略名称

policy_type

String

进程白名单策略类型

  • allow # 允许指定/授权进程运行

  • block # 阻止潜在恶意软件运行

learning_status

String

参数解释:

策略学习状态

约束限制:

不涉及

取值范围:

  • effecting:学习完成,策略生效

  • learned:学习完成,待确认

  • learning:学习中

  • pause:暂停

  • abnormal:学习异常

默认取值:

不涉及

intercept

Boolean

参数解释

是否开启阻断

约束限制:

不涉及

取值范围:

  • true:是

  • false:否

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data_list

Array of AppWhitelistPolicyResponseInfo objects

data list

total_num

Integer

参数解释:

总数

取值范围:

最小值0,最大值2147483647

表5 AppWhitelistPolicyResponseInfo

参数

参数类型

描述

policy_id

String

策略ID

policy_name

String

策略名称

policy_type

String

参数解释

进程白名单策略类型

取值范围:

  • allow:允许指定/授权进程运行

  • block:阻止潜在恶意软件运行

learning_status

String

参数解释

服务器名称

约束限制:

不涉及

取值范围:

  • effecting:学习完成,策略生效

  • learned:学习完成,待确认

  • learning:学习中

  • pause:暂停

  • abnormal:学习异常

默认取值:

不涉及

learning_days

Integer

参数解释:

策略学习天数

取值范围:

最小值1,最大值1000

specified_dir

Boolean

参数解释

是否指定学习目录

约束限制

不涉及

取值范围:

  • true:是

  • false:否

默认取值

不涉及

dir_list

Array of strings

监控目录列表

file_extension_list

Array of strings

监控文件后缀名列表

intercept

Boolean

参数解释

是否开启阻断

取值范围:

  • true:是

  • false:否

auto_detect

Boolean

参数解释

是否自动开启检测

取值范围:

  • true:是

  • false:否

not_effect_host_num

Integer

参数解释:

学习完成策略未生效主机数

取值范围:

最小值0,最大值2147483647

effect_host_num

Integer

参数解释:

学习完成策略已生效主机数

取值范围:

最小值0,最大值2147483647

trust_num

Integer

参数解释:

识别可信进程数

取值范围:

最小值0,最大值2147483647

suspicious_num

Integer

参数解释:

识别可疑进程数

取值范围:

最小值0,最大值2147483647

malicious_num

Integer

参数解释:

识别恶意进程数

取值范围:

最小值0,最大值2147483647

unknown_num

Integer

参数解释:

识别未知进程数

取值范围:

最小值0,最大值2147483647

abnormal_info_list

Array of AppWhitelistAbnormalInfo objects

学习异常原因列表

auto_confirm

Boolean

参数解释

是否自动确认学习结果

取值范围:

  • true:是

  • false:否

default_policy

Boolean

参数解释

默认进程白名单策略

取值范围:

  • true:是

  • false:否

host_id_list

Array of strings

主机id集合

表6 AppWhitelistAbnormalInfo

参数

参数类型

描述

abnormal_type

Integer

异常类型

abnormal_description

String

异常描述

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "policy_id" : "e208b***-f2e8-48bf-a9fe-a8******d900",
    "policy_name" : "app_whitelist_20250117161121",
    "policy_type" : "block",
    "learning_status" : "learning",
    "learning_days" : 7,
    "specified_dir" : false,
    "intercept" : false,
    "trust_num" : 0,
    "suspicious_num" : 0,
    "malicious_num" : 0,
    "unknown_num" : 0,
    "effect_host_num" : 0,
    "not_effect_host_num" : 1,
    "auto_detect" : true,
    "host_id_list" : [ "a241d890-34cb-4747-bce8-2a5f35df67bd" ],
    "default_policy" : false,
    "auto_confirm" : true
  } ]
}

SDK代码示例

SDK代码示例如下。

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

    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();
        ListAppWhitelistPolicyRequest request = new ListAppWhitelistPolicyRequest();
        try {
            ListAppWhitelistPolicyResponse response = client.listAppWhitelistPolicy(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 = ListAppWhitelistPolicyRequest()
        response = client.list_app_whitelist_policy(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.ListAppWhitelistPolicyRequest{}
	response, err := client.ListAppWhitelistPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码