Querying Cluster Protection Information

Function

This API is used to query cluster protection information.

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/clusters

**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.
offset	Yes	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value N/A
limit	Yes	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10

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	Definition Total number. Range Minimum value: 0; maximum value: 10,000
data_list	Array of ClusterResponseInfo objects	Definition Cluster protection information list Range The value can contain 0 to 10,000 ClusterResponseInfo objects.

**Table 5** ClusterResponseInfo
Parameter	Type	Description
cluster_name	String	Definition Cluster name. Range N/A
cluster_id	String	Definition Cluster ID. Range N/A
cluster_version	String	Definition Cluster version. Range N/A
protect_status	String	Definition Whitelist rule type. 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
policy_num	Integer	Definition Number of policies. Range N/A
cluster_status	String	Definition Cluster status. Range Available Unavailable
cluster_type	String	Definition Cluster type. Range k8s: native Kubernetes cluster cce: CCE cluster ali: Alibaba Cloud cluster tencent: Tencent Cloud cluster azure: Microsoft Azure Cloud cluster aws: AWS Cloud cluster self_built_hw: customer-built cluster on Huawei Cloud self_built_idc: IDC on-premises cluster

Example Requests

Query cluster protection information.

GET https://{endpoint}/v5/{project_id}/cluster-protect/clusters?offset=0&limit=200&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Cluster protection list

{
  "total_num" : 14,
  "data_list" : [ {
    "cluster_id" : "05677f29-1ab0-4ea0-91a3-a72cb8bae59c",
    "cluster_name" : "dfx-master",
    "cluster_type" : "self_built_idc",
    "policy_num" : 0,
    "protect_status" : "unprotected",
    "cluster_status" : "Available"
  } ]
}