Updated on 2025-09-08 GMT+08:00

Querying the List of Protected Servers

Function

Querying the protected server list: Query protected server data, including the server name, IP address, operating system, server group name, protection policy, protection status, microservice protection status, RASP protection status, and number of attacks prevented by RASP.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/rasp/servers

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

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

Yes

Integer

Start time of the query.

limit

Yes

Integer

Number of records displayed on each page.

host_name

No

String

Server name

os_type

No

String

OS type. Its value can be:

  • linux: Linux application protection

  • windows: Windows application protection

host_ip

No

String

Server private IP address

app_type

No

String

Application type. The value can be:

  • java: Java application protection.

app_status

Yes

String

Application protection status. The options are as follows:

  • closed: protection disabled

  • opened: protection enabled

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

x-auth-token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total

data_list

Array of ProtectionServeInfo objects

list

Table 5 ProtectionServeInfo

Parameter

Type

Description

host_id

String

Server ID

agent_id

String

Agent ID

agent_version

String

Agent version

host_name

String

Server name

public_ip

String

EIP

private_ip

String

Private IP address.

os_type

String

OS type

rasp_status

String

Application protection status

Application protection status. The options are as follows:

  • 0: Protection is being enabled.

  • 2: protected

  • 4: Protection failed (installation failed).

  • 6: unprotected.

  • 8: partially protected.

  • 9: Protection failed.

policy_name

String

Protection policy name

is_friendly_user

Boolean

Whether the user is a friendly user

agent_support_auto_attach

Boolean

Whether the agent supports dynamic loading

agent_status

String

Agent status

auto_attach

Boolean

Whether the dynamic loading is enabled.

protect_status

String

Protection status

Agent protection status. It can be:

  • 0: disabled

  • 1: enabled

group_id

String

Server group ID

group_name

String

Server group name

protect_event_num

Long

Number of protection events

rasp_port

Integer

RASP port number

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "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" : "Default policy",
    "agent_support_auto_attach" : true,
    "is_friendly_user" : 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 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)
    }
}

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.