文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 集群防护/ 获取集群防护默认策略列表 - ListClusterProtectionDefaultPolicy
更新时间:2026-09-14 GMT+08:00
分享

获取集群防护默认策略列表 - ListClusterProtectionDefaultPolicy

功能介绍

获取集群防护默认策略列表。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/cluster-protect/default-policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

offset

是

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

不涉及

limit

是

Integer

参数解释:

每页显示个数

约束限制:

必填

取值范围:

取值10-200

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

总数

取值范围:

最小值0,最大值10000

x_auth_token

String

参数解释:

用户Token

取值范围:

字符长度1-32768位

project_id

String

参数解释:

项目ID

取值范围:

字符长度1-32768位

enterprise_project_id

String

参数解释:

主机所属的企业项目ID

取值范围:

字符长度1-256位

region

String

参数解释:

Region ID

取值范围:

字符长度1-32768位

general_policy_num

Integer

参数解释:

通用策略数

取值范围:

最小值0,最大值2147483647

malicious_image_policy_num

Integer

参数解释:

恶意镜像策略数

取值范围:

最小值0,最大值2147483647

security_policy_num

Integer

参数解释:

安全镜像策略数

取值范围:

最小值0,最大值2147483647

data_list

Array of ClusterPolicyResponseInfo objects

参数解释:

集群防护策略列表

取值范围:

取值0-10000个ClusterPolicyResponseInfo对象

表5 ClusterPolicyResponseInfo

参数

参数类型

描述

cluster_id

String

参数解释:

集群ID

取值范围:

不涉及

cluster_name

String

参数解释:

集群名称

取值范围:

不涉及

content

Object

参数解释:

策略内容

取值范围:

不涉及

deploy_content

String

参数解释:

部署内容

取值范围:

不涉及

parameters

String

参数解释:

参数

取值范围:

不涉及

policy_name

String

参数解释:

策略名称

取值范围:

不涉及

policy_id

String

参数解释:

策略ID

取值范围:

不涉及

resources

Array of Resources objects

参数解释:

资源

取值范围:

不涉及

template_id

String

参数解释:

模板ID

取值范围:

不涉及

template_name

String

参数解释:

模板名称

取值范围:

不涉及

template_type

String

参数解释:

模板类型

取值范围:

不涉及

description

String

参数解释:

策略描述

取值范围:

不涉及

update_time

Integer

参数解释:

更新时间

取值范围:

不涉及

create_time

Integer

参数解释:

创建时间

取值范围:

不涉及

image_num

Integer

参数解释:

防护镜像数量

取值范围:

不涉及

labels_num

Integer

参数解释:

防护标签数量

取值范围:

不涉及

status

String

参数解释:

状态

取值范围:

不涉及

white_images

Array of WhiteImageInfo objects

参数解释:

白名单镜像

取值范围:

不涉及

表6 Resources

参数

参数类型

描述

cluster_id

String

参数解释:

集群id

取值范围:

不涉及

cluster_name

String

参数解释:

集群名称

取值范围:

不涉及

images

Array of strings

参数解释:

镜像列表

取值范围:

不涉及

labels

Array of strings

参数解释:

标签列表

取值范围:

不涉及

namespace

String

参数解释:

命名空间

取值范围:

不涉及

表7 WhiteImageInfo

参数

参数类型

描述

cluster_id

String

参数解释:

集群ID

取值范围:

不涉及

image_name

String

参数解释:

镜像名称

取值范围:

不涉及

image_version

String

参数解释:

镜像版本

取值范围:

不涉及

请求示例

获取集群防护默认策略列表

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

响应示例

状态码:200

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

SDK代码示例

SDK代码示例如下。

 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
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.*;


public class ListClusterProtectionDefaultPolicySolution {

    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();
        ListClusterProtectionDefaultPolicyRequest request = new ListClusterProtectionDefaultPolicyRequest();
        try {
            ListClusterProtectionDefaultPolicyResponse response = client.listClusterProtectionDefaultPolicy(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());
        }
    }
}
 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
# 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 = ListClusterProtectionDefaultPolicyRequest()
        response = client.list_cluster_protection_default_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)
 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
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := hss.HssClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := hss.NewHssClient(hcClient)

    request := &model.ListClusterProtectionDefaultPolicyRequest{}
	response, err := client.ListClusterProtectionDefaultPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档