Creating a Cluster Protection Policy

Function

This API is used to create a cluster protection policy.

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

POST /v5/{project_id}/cluster-protect/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.

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

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
policy_name	Yes	String	Policy Name
policy_id	Yes	String	Policy ID
template_id	Yes	String	Template ID
policy_description	Yes	String	Description
content	Yes	PolicyContent object	Policy Content
white_image_list	Yes	Array of WhiteImageInfo objects	Whitelisted image
resources	Yes	Array of PolicyProtectScope objects	Protected resource information
parameters	Yes	String	Policy Parameter Value

**Table 5** PolicyContent
Parameter	Mandatory	Type	Description
enable_image_startup	Yes	Boolean	Whether to allow the startup of unscanned images
policy_type	Yes	String	Alarm policy type. It can be: vuls: vulnerability baselines: baseline malwares: malicious script
severity	Yes	Integer	Risk Severity
risky_item	Yes	Array of strings	Risky item
action	Yes	Integer	Protective Actions 0: report an alarm 1: block 2: allow

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

**Table 7** PolicyProtectScope
Parameter	Mandatory	Type	Description
cluster_name	Yes	String	Cluster Name
cluster_id	Yes	String	Cluster ID
images	Yes	Array of strings	Protected image
namespaces	Yes	Array of strings	Protected namespace
labels	Yes	Array of strings	Protection labels

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

This API is used to create a cluster protection policy.

POST https://{endpoint}/v5/{project_id}/cluster-protect/policy?enterprise_project_id=all_granted_eps

{
  "policy_name" : "string",
  "policy_id" : "string",
  "template_id" : "string",
  "policy_description" : "string",
  "content" : {
    "enable_image_startup" : true,
    "policy_type" : "string",
    "severity" : 0,
    "risky_item" : [ "string" ],
    "action" : 0
  },
  "white_image_list" : [ {
    "cluster_id" : "string",
    "image_name" : "string",
    "image_version" : "string"
  } ],
  "resources" : [ {
    "cluster_name" : "string",
    "cluster_id" : "string",
    "images" : [ "string" ],
    "namespaces" : [ "string" ],
    "labels" : [ "string" ]
  } ],
  "parameters" : "string"
}