Updated on 2025-08-15 GMT+08:00

Creating a Cluster Protection Policy

Function

This API is used to create a cluster protection policy.

Calling Method

For details, see Calling APIs.

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

Specifies the cluster ID.

image_name

Yes

String

Image Name

image_version

Yes

String

Image version

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" ]
  } ]
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

This API is used to create a cluster protection policy.

 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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateClusterProtectionPolicySolution {

    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();
        CreateClusterProtectionPolicyRequest request = new CreateClusterProtectionPolicyRequest();
        ModPolicyRequestInfo body = new ModPolicyRequestInfo();
        List<String> listResourcesLabels = new ArrayList<>();
        listResourcesLabels.add("string");
        List<String> listResourcesNamespaces = new ArrayList<>();
        listResourcesNamespaces.add("string");
        List<String> listResourcesImages = new ArrayList<>();
        listResourcesImages.add("string");
        List<PolicyProtectScope> listbodyResources = new ArrayList<>();
        listbodyResources.add(
            new PolicyProtectScope()
                .withClusterName("string")
                .withClusterId("string")
                .withImages(listResourcesImages)
                .withNamespaces(listResourcesNamespaces)
                .withLabels(listResourcesLabels)
        );
        List<WhiteImageInfo> listbodyWhiteImageList = new ArrayList<>();
        listbodyWhiteImageList.add(
            new WhiteImageInfo()
                .withClusterId("string")
                .withImageName("string")
                .withImageVersion("string")
        );
        List<String> listContentRiskyItem = new ArrayList<>();
        listContentRiskyItem.add("string");
        PolicyContent contentbody = new PolicyContent();
        contentbody.withEnableImageStartup(true)
            .withPolicyType("string")
            .withSeverity(0)
            .withRiskyItem(listContentRiskyItem)
            .withAction(0);
        body.withResources(listbodyResources);
        body.withWhiteImageList(listbodyWhiteImageList);
        body.withContent(contentbody);
        body.withPolicyDescription("string");
        body.withTemplateId("string");
        body.withPolicyId("string");
        body.withPolicyName("string");
        request.withBody(body);
        try {
            CreateClusterProtectionPolicyResponse response = client.createClusterProtectionPolicy(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());
        }
    }
}

This API is used to create a cluster protection policy.

 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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# 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 = CreateClusterProtectionPolicyRequest()
        listLabelsResources = [
            "string"
        ]
        listNamespacesResources = [
            "string"
        ]
        listImagesResources = [
            "string"
        ]
        listResourcesbody = [
            PolicyProtectScope(
                cluster_name="string",
                cluster_id="string",
                images=listImagesResources,
                namespaces=listNamespacesResources,
                labels=listLabelsResources
            )
        ]
        listWhiteImageListbody = [
            WhiteImageInfo(
                cluster_id="string",
                image_name="string",
                image_version="string"
            )
        ]
        listRiskyItemContent = [
            "string"
        ]
        contentbody = PolicyContent(
            enable_image_startup=True,
            policy_type="string",
            severity=0,
            risky_item=listRiskyItemContent,
            action=0
        )
        request.body = ModPolicyRequestInfo(
            resources=listResourcesbody,
            white_image_list=listWhiteImageListbody,
            content=contentbody,
            policy_description="string",
            template_id="string",
            policy_id="string",
            policy_name="string"
        )
        response = client.create_cluster_protection_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

This API is used to create a cluster protection policy.

 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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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.CreateClusterProtectionPolicyRequest{}
	var listLabelsResources = []string{
        "string",
    }
	var listNamespacesResources = []string{
        "string",
    }
	var listImagesResources = []string{
        "string",
    }
	var listResourcesbody = []model.PolicyProtectScope{
        {
            ClusterName: "string",
            ClusterId: "string",
            Images: listImagesResources,
            Namespaces: listNamespacesResources,
            Labels: listLabelsResources,
        },
    }
	var listWhiteImageListbody = []model.WhiteImageInfo{
        {
            ClusterId: "string",
            ImageName: "string",
            ImageVersion: "string",
        },
    }
	var listRiskyItemContent = []string{
        "string",
    }
	contentbody := &model.PolicyContent{
		EnableImageStartup: true,
		PolicyType: "string",
		Severity: int32(0),
		RiskyItem: listRiskyItemContent,
		Action: int32(0),
	}
	request.Body = &model.ModPolicyRequestInfo{
		Resources: listResourcesbody,
		WhiteImageList: listWhiteImageListbody,
		Content: contentbody,
		PolicyDescription: "string",
		TemplateId: "string",
		PolicyId: "string",
		PolicyName: "string",
	}
	response, err := client.CreateClusterProtectionPolicy(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.