Obtaining the List of Default Cluster Protection Policies

Function

This API is used to obtain the list of default cluster protection policies.

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/default-policy

**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
x_auth_token	String	Definition User token. Range The value can contain 1 to 32,768 characters.
project_id	String	Definition Project ID. Range The value can contain 1 to 32,768 characters.
enterprise_project_id	String	Definition ID of the enterprise project that the server belongs to. Range The value can contain 1 to 256 characters.
region	String	Definition Region ID Range The value can contain 1 to 32,768 characters.
general_policy_num	Integer	Definition Number of common policies. Range The value range is 0 to 2,147,483,647.
malicious_image_policy_num	Integer	Definition Number of malicious image policies. Range The value range is 0 to 2,147,483,647.
security_policy_num	Integer	Definition Number of secure image policies. Range The value range is 0 to 2,147,483,647.
data_list	Array of ClusterPolicyResponseInfo objects	Definition Cluster protection policy list Range The value can contain 0 to 10,000 ClusterPolicyResponseInfo objects.

**Table 5** ClusterPolicyResponseInfo
Parameter	Type	Description
cluster_id	String	Definition Cluster ID. Range N/A
cluster_name	String	Definition Cluster name. Range N/A
content	Object	Definition Policy content. Range N/A
deploy_content	String	Definition Deployment content. Range N/A
parameters	String	Definition Parameter. Range N/A
policy_name	String	Definition Policy name. Range N/A
policy_id	String	Definition Policy ID. Range N/A
resources	Array of Resources objects	Definition Resource. Range N/A
template_id	String	Definition Template ID. Range N/A
template_name	String	Definition Template name. Range N/A
template_type	String	Definition Template type. Range N/A
description	String	Definition Description. Range N/A
update_time	Integer	Definition Update time. Range N/A
create_time	Integer	Definition Creation time. Range N/A
image_num	Integer	Definition Number of protected images. Range N/A
labels_num	Integer	Definition Number of protection labels. Range N/A
status	String	Definition Status. Range N/A
white_images	Array of WhiteImageInfo objects	Definition Whitelisted image. Range N/A

**Table 6** Resources
Parameter	Type	Description
cluster_id	String	Definition Cluster ID. Range N/A
cluster_name	String	Definition Cluster name. Range N/A
images	String	Definition Image. Range N/A
labels	String	Definition Tag. Range N/A
namespace	String	Definition Namespace. Range N/A

**Table 7** WhiteImageInfo
Parameter	Type	Description
cluster_id	String	Definition Cluster ID. Range N/A
image_name	String	Definition Image name. Range N/A
image_version	String	Definition Image tag. Range N/A

Example Requests

This API is used to obtain the list of default cluster protection policies.

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

Example Responses

Status code: 200

Request succeeded.

{
  "project_id" : "",
  "enterprise_project_id" : "0",
  "total_num" : 0,
  "data_list" : [ ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Cluster Protection

Previous topic: Querying Cluster Protection Information

Next topic: Obtaining Alarm Events in All Clusters

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot