Help Center/ Host Security Service/ API Reference/ API Description/ Cluster Protection/ Obtaining All the Protection Items of a Cluster
Updated on 2025-08-15 GMT+08:00

Obtaining All the Protection Items of a Cluster

Function

This API is used to obtain all the protection items of a cluster.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/cluster-protect/protection-item

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

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.

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

total_num

Integer

Total

vuls

Array of strings

Vulnerability details

baselines

Array of ClusterBaselineResponseInfo objects

Baseline information

malwares

Array of ClusterMalwareResponseInfo objects

Malicious file information

images

Array of ClusterImageResponseInfo objects

Images

clusters

Array of ClusterItemResponseInfo objects

Cluster information

Table 5 ClusterBaselineResponseInfo

Parameter

Type

Description

baseline_desc

String

Check item description

baseline_index

String

Check item ID

baseline_type

String

Check item type

Table 6 ClusterMalwareResponseInfo

Parameter

Type

Description

malware_type

String

Malicious file type.

Table 7 ClusterImageResponseInfo

Parameter

Type

Description

image_name

String

Image name

image_version

String

Image version

id

String

ID

Table 8 ClusterItemResponseInfo

Parameter

Type

Description

cluster_id

String

Cluster ID

cluster_name

String

Cluster name

cluster_ns

Array of strings

Cluster namespace

cluster_labels

Array of strings

Cluster label

protect_status

String

Cluster protection status. | - 0: unprotected; - 1: plugin error; - 2: protected with policy; - 3: deploy policy failed; - 4: protected without policy; - 5: uninstall failed; - 6: uninstall; - 7: installing

Example Requests

This API is used to obtain all the protection items of a cluster.

GET https://{endpoint}/v5/{project_id}/cluster-protect/protection-item?enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "vuls" : [ "CVE-2002-2443", "CVE-2005-1849", "CVE-2009-5155", "CVE-2011-2895", "CVE-2011-5325", "CVE-2012-3425", "CVE-2012-5630" ],
  "baselines" : [ {
    "baseline_desc" : "Rule: Restrict the access permission on **/etc/ssh/sshd_config**.",
    "baseline_index" : "1.1",
    "baseline_type" : "SSH"
  }, {
    "baseline_desc" : "Rule: Use the Ciphers algorithm, which is more secure.",
    "baseline_index" : "1.10",
    "baseline_type" : "SSH"
  } ],
  "malwares" : [ {
    "malware_type" : "malwares"
  } ],
  "images" : [ {
    "id" : "43170",
    "image_name" : "anp-agent",
    "image_version" : "0.0.2"
  }, {
    "id" : "17518",
    "image_name" : "webshell-ljx",
    "image_version" : "v1"
  } ],
  "clusters" : [ {
    "cluster_id" : "08e932a3-a7f0-4d60-ae45-09a629eb3be7",
    "cluster_name" : "test-617-rrrrrrrr",
    "protect_status" : "1"
  }, {
    "cluster_id" : "441e4d05-7f90-11ee-b311-0255ac1001b2",
    "cluster_name" : "ops-show-cluster-1110",
    "cluster_ns" : [ "default", "cgs-provider", "monitoring", "test-dasd", "hss", "ljx-test" ],
    "protect_status" : "0"
  }, {
    "cluster_id" : "ba732ee6-3067-11ef-8743-0255ac1001b4",
    "cluster_name" : "liuzhaoling-tarenwudong",
    "cluster_ns" : [ "default", "hss" ],
    "protect_status" : "0"
  }, {
    "cluster_id" : "a24b6cb6-3469-11ef-846b-0255ac100b03",
    "cluster_name" : "cce-lxl-0627-2",
    "protect_status" : "0"
  } ],
  "total_num" : 2817
}

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

    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();
        ListClusterProtectionItemRequest request = new ListClusterProtectionItemRequest();
        try {
            ListClusterProtectionItemResponse response = client.listClusterProtectionItem(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 = ListClusterProtectionItemRequest()
        response = client.list_cluster_protection_item(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.ListClusterProtectionItemRequest{}
	response, err := client.ListClusterProtectionItem(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.