文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 集群防护/ 查看指定策略的详情 - ListClusterProtectionPolicyDetail
更新时间:2025-11-28 GMT+08:00
分享

查看指定策略的详情 - ListClusterProtectionPolicyDetail

功能介绍

查看指定策略的详情

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

policy_id

String

参数解释

策略ID

约束限制

必填

取值范围

字符长度1-64位

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

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

请求参数

表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

String

参数解释

镜像

取值范围

不涉及

labels

String

参数解释

标签

取值范围

不涉及

namespace

String

参数解释

命名空间

取值范围

不涉及

表7 WhiteImageInfo

参数

参数类型

描述

cluster_id

String

参数解释

集群ID

取值范围

不涉及

image_name

String

参数解释

镜像名称

取值范围

不涉及

image_version

String

参数解释

镜像版本

取值范围

不涉及

请求示例

响应示例

状态码:200

请求已成功

{
  "project_id" : "",
  "enterprise_project_id" : "0",
  "total_num" : 3,
  "data_list" : [ {
    "policy_id" : "042a0ffd-6883-4ea6-be28-9e20ff83cb10",
    "policy_name" : "默认模板",
    "template_id" : "",
    "description" : "testK8s",
    "content" : {
      "enable_image_startup" : false,
      "policy_type" : "baselines",
      "severity" : 4,
      "risky_item" : [ "1.1", "1.10", "1.11", "1.12", "1.13", "1.14", "1.15", "1.16", "1.17", "1.2", "1.3", "1.4", "1.5", "1.6", "1.7", "1.8", "1.9" ],
      "action" : 0
    },
    "resources" : [ {
      "cluster_name" : "test-lby",
      "cluster_id" : "149dab20-2ebb-4925-8ca8-6bfd511a8f01",
      "namespaces" : [ "default", "openebs", "hss" ],
      "labels" : [ ],
      "images" : [ "anp-agent", "apptest", "busybox", "cce-install-agent", "cce-install-agent-aarch64", "cce-install-agent-x86_64", "centos", "centos-malwarefile-spring", "centos7", "centosnew" ]
    } ],
    "image_num" : 10,
    "labels_num" : 0,
    "cluster_id" : "149dab20-2ebb-4925-8ca8-6bfd511a8f01",
    "cluster_name" : "test-lby",
    "status" : "inuse",
    "white_images" : [ ]
  }, {
    "policy_id" : "23c4fe52-413f-4f5c-8717-e8e3545fb87a",
    "policy_name" : "hss-glz-test-01",
    "template_id" : "",
    "description" : "hss-glz-test-01",
    "content" : {
      "enable_image_startup" : false,
      "policy_type" : "baselines",
      "severity" : 7,
      "risky_item" : [ "1.1", "1.10", "1.11", "1.12", "1.13", "1.14", "1.15", "1.16", "1.17", "1.2", "1.3", "1.4", "1.5", "1.6", "1.7", "1.8", "1.9" ],
      "action" : 0
    },
    "resources" : [ {
      "cluster_name" : "hss-glz-2451",
      "cluster_id" : "1ff15c8b-2265-11ef-8338-0255ac1001b2",
      "namespaces" : [ "monitoring" ],
      "labels" : [ ],
      "images" : [ "centos7" ]
    } ],
    "image_num" : 1,
    "labels_num" : 0,
    "cluster_id" : "1ff15c8b-2265-11ef-8338-0255ac1001b2",
    "cluster_name" : "hss-glz-2451",
    "status" : "inuse",
    "white_images" : [ ]
  }, {
    "policy_id" : "2ee2614d-2f17-4889-8c59-1e9f3f38fadb",
    "policy_name" : "默认模板",
    "template_id" : "",
    "description" : "teshw01",
    "content" : {
      "enable_image_startup" : false,
      "policy_type" : "malwares",
      "severity" : 4,
      "risky_item" : [ "malwares" ],
      "action" : 0
    },
    "resources" : [ {
      "cluster_name" : "showcase-private",
      "cluster_id" : "cc59fbaf-b837-4779-b574-b3ad6e45c392",
      "namespaces" : [ "k8sdemo", "hss", "default", "openebs" ],
      "labels" : [ ],
      "images" : [ "apptest", "busybox", "cce-install-agent", "cce-install-agent-aarch64", "cce-install-agent-x86_64", "centos", "centos-malwarefile-spring", "centos7", "centosnew", "cfgtest", "cgs-provider", "cgs-shield", "consul", "couchdb", "debian", "debian-test", "debian113test", "django", "dxn", "euler2sp2", "euleros", "euleros/test", "f-image-test-2", "gatekeeper-x86_64", "hce_arm", "hello-world", "hss-admission-controller", "hss-agent-install", "hss-opa-docker-authz", "hss-opa-docker-authz-linux", "hss-opa-docker-authz-linux-amd64", "hss-opa-docker-authz-linux-arm64", "imagescan-centos-release-test", "imagescan-deb-pkg-test", "imagescan-suse-release-test", "install-hss-agent", "java-debian10", "lib-roa", "log4j", "lzldockerfile", "lzldockerfle", "modelarts_outter_base_tensorflow_2_3", "mysql", "mysql-ljx", "nginx", "openeuler", "openeuler-x86_64", "openjdk", "pause-amd64", "performance_test", "poctest", "poctest2", "poctest3", "poctest4", "poctest5", "python-0920", "ssh-server", "tomcat", "ubuntu", "ubuntu-contain13", "vul-img-3", "vul-img-4", "vul-img-5", "webshell-ljx" ]
    } ],
    "image_num" : 64,
    "labels_num" : 0,
    "cluster_id" : "cc59fbaf-b837-4779-b574-b3ad6e45c392",
    "cluster_name" : "showcase-private",
    "status" : "inuse",
    "white_images" : [ ]
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档