Obtaining All the Protection Items of a Cluster

Function

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

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	Definition Cluster Protection Status Range unprotected: not protected plugin error protected with policy: protected by a policy deploy policy failed: Policy deployment failed. protected without policy: not protected by any policies uninstall failed: Uninstallation failed. uninstall installing: Installation is in progress.

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
}