文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 应用防护/ 查询防护服务器列表 - ListProtectionServers
更新时间:2025-12-26 GMT+08:00
分享

查询防护服务器列表 - ListProtectionServers

功能介绍

查询防护服务器列表:查询防护服务器相关数据,包含服务器名称、ip地址、操作系统、服务器组名称、防护策略、防护状态、微服务防护状态、RASP防护状态、RASP攻击数量信息。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/rasp/servers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

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

offset

Integer

查询起始点

limit

Integer

每页显示个数

host_name

String

云主机名称

os_type

String

操作系统类型,包含如下2种。

  • Linux

  • Windows

host_ip

String

云主机私有IP

app_type

String

应用类型,包含如下1种。

  • java :java类型应用防护。

枚举值:

  • java

app_status

String

应用防护状态,包含如下2种。

  • closed :未开启。

  • opened :防护中。

枚举值:

  • closed

  • opened

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

data_list

Array of ProtectionServeInfo objects

list

表5 ProtectionServeInfo

参数

参数类型

描述

host_id

String

服务器ID

agent_id

String

Agent ID

agent_version

String

Agent版本

host_name

String

服务器名称

public_ip

String

弹性ip地址

private_ip

String

私有ip

os_type

String

参数解释:

策略支持的操作系统

约束限制:

不涉及

取值范围:

包含如下:

  • Windows : Windows系统

  • Linux : Linux系统

默认取值:

不涉及

rasp_status

String

参数解释:

应用防护状态

约束限制:

不涉及

取值范围:

包含如下7种。

  • app_install_processing:防护开启中。

  • app_protected:防护成功。

  • app_install_failed:防护失败(安装失败)。

  • app_not_configure:未防护。

  • app_partially_protected:部分防护。

  • app_all_failed:防护失败。

  • app_uninstall_processing:卸载中。

默认取值:

不涉及

policy_name

String

防护策略名称

is_friendly_user

Boolean

是否为友好用户

agent_support_auto_attach

Boolean

agent是否支持动态加载

agent_status

String

参数解释:

Agent状态

约束限制:

不涉及

取值范围:

包含如下6种。

  • installed :已安装。

  • not_installed :未安装。

  • online :在线。

  • offline :离线。

  • install_failed :安装失败。

  • installing :安装中。

默认取值:

不涉及

auto_attach

Boolean

动态加载是否开启

protect_status

String

防护状态 |- agent防护状态,包含如下2种。 - 0 :关闭。 - 1 :开启。

group_id

String

服务器组ID

group_name

String

服务器组名称

protect_event_num

Long

防护事件数

rasp_port

Integer

RASP端口号

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 9,
  "data_list" : [ {
    "host_id" : "d04e7903-0a66-4fde-93e7-*******",
    "agent_id" : "06af36ee0874501a2***********bb908fb818a8fdf2e0af487457ebc22",
    "agent_version" : "3.2.17",
    "host_name" : "ecs-******-nacos-test",
    "public_ip" : "",
    "private_ip" : "192.168.0.**",
    "os_type" : "Linux",
    "group_id" : "d9327506-5282-3017-9077-******",
    "protect_event_num" : 0,
    "rasp_port" : 19999,
    "auto_attach" : false,
    "rasp_status" : "app_not_configure",
    "protect_status" : "opened",
    "policy_name" : "默认策略",
    "agent_support_auto_attach" : true,
    "is_friendly_user" : 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 ListProtectionServersSolution {

    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();
        ListProtectionServersRequest request = new ListProtectionServersRequest();
        try {
            ListProtectionServersResponse response = client.listProtectionServers(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 = ListProtectionServersRequest()
        response = client.list_protection_servers(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.ListProtectionServersRequest{}
	response, err := client.ListProtectionServers(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档