查询集群组件防护策略模板
功能介绍
查询集群防护策略模板
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/container/clusters/protection-policy-templates/{policy_template_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
policy_template_id |
是 |
String |
策略模板ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
主机所属的企业项目ID。 开通企业项目功能后才需要配置企业项目。 企业项目ID默认取值为“0”,表示默认企业项目。如果需要查询所有企业项目下的主机,请传参“all_granted_eps”。如果您只有某个企业项目的权限,则需要传递该企业项目ID,查询该企业项目下的主机,否则会因权限不足而报错。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
模板ID |
template_name |
String |
模板名称 |
template_type |
String |
模板类型 |
description |
String |
描述 |
target_kind |
String |
策略模板应用资源类型,多个资源类型通过分号份隔连接 |
tag |
String |
标签 |
level |
String |
推荐级别 |
constraint_template |
String |
策略模板内容 |
请求示例
无
响应示例
状态码:200
请求已成功
{ "id" : "string", "template_name" : "string", "template_type" : "string", "description" : "string", "target_kind" : "Deployment;ReplicaSet;CornJob", "tag" : "string", "level" : "strin", "constraint_template" : { "kind" : "ConstraintTemplate", "apiVersion" : "templates.gatekeeper.sh/v1", "metadata" : { "name" : "k8spspprocmount", "creationTimestamp" : null, "annotations" : { "description" : "Controls the allowed `procMount` types for the container. Corresponds to the `allowedProcMountTypes` field in a PodSecurityPolicy. For more information, see https://kubernetes.io/docs/concepts/policy/pod-security-policy/#allowedprocmounttypes", "description-chinese" : "限制Pod允许挂载的Proc类型", "level" : "3", "metadata.gatekeeper.sh/title" : "Proc Mount", "metadata.gatekeeper.sh/version" : "1.0.0", "name-chinese" : "K8sPSPProcMount", "tag" : "Container/ApplicationSecurityPolicies", "tag-chinese" : "容器/应用安全策略", "targetKind" : "Pod", "type" : "security" } }, "spec" : { "crd" : { "spec" : { "names" : { "kind" : "K8sPSPProcMount" }, "validation" : { "openAPIV3Schema" : { "description" : "Controls the allowed `procMount` types for the container. Corresponds to the `allowedProcMountTypes` field in a PodSecurityPolicy. For more information, see https://kubernetes.io/docs/concepts/policy/pod-security-policy/#allowedprocmounttypes", "type" : "object", "properties" : { "exemptImages" : { "description" : "Any container that uses an image that matches an entry in this list will be excluded from enforcement. Prefix-matching can be signified with `*`. For example: `my-image-*`.\nIt is recommended that users use the fully-qualified Docker image name (e.g. start with a domain name) in order to avoid unexpectedly exempting images from an untrusted repository.", "type" : "array", "items" : { "type" : "string" } }, "procMount" : { "description" : "Defines the strategy for the security exposure of certain paths in `/proc` by the container runtime. Setting to `Default` uses the runtime defaults, where `Unmasked` bypasses the default behavior.", "type" : "string", "enum" : [ "Default", "Unmasked" ] } } } } } }, "targets" : [ { "target" : "admission.k8s.gatekeeper.sh", "rego" : "package k8spspprocmount\nimport data.lib.exempt_container.is_exempt\nviolation[{\"msg\": msg, \"details\": {}}] {\n c := input_containers[_]\n not is_exempt(c)\n allowedProcMount := get_allowed_proc_mount(input)\n not input_proc_mount_type_allowed(allowedProcMount, c)\n msg := sprintf(\"ProcMount type is not allowed, container: %v. Allowed procMount types: %v\", [c.name, allowedProcMount])\n}\ninput_proc_mount_type_allowed(allowedProcMount, c) {\n allowedProcMount == \"default\"\n lower(c.securityContext.procMount) == \"default\"\n}\ninput_proc_mount_type_allowed(allowedProcMount, c) {\n allowedProcMount == \"unmasked\"\n}\ninput_containers[c] {\n c := input.review.object.spec.containers[_]\n c.securityContext.procMount\n}\ninput_containers[c] {\n c := input.review.object.spec.initContainers[_]\n c.securityContext.procMount\n}\ninput_containers[c] {\n c := input.review.object.spec.ephemeralContainers[_]\n c.securityContext.procMount\n}\nget_allowed_proc_mount(arg) = out {\n not arg.parameters\n out = \"default\"\n}\nget_allowed_proc_mount(arg) = out {\n not arg.parameters.procMount\n out = \"default\"\n}\nget_allowed_proc_mount(arg) = out {\n not valid_proc_mount(arg.parameters.procMount)\n out = \"default\"\n}\nget_allowed_proc_mount(arg) = out {\n out = lower(arg.parameters.procMount)\n}\nvalid_proc_mount(str) {\n lower(str) == \"default\"\n}\nvalid_proc_mount(str) {\n lower(str) == \"unmasked\"\n}", "libs" : [ "package lib.exempt_container\nis_exempt(container) {\n exempt_images := object.get(object.get(input, \"parameters\", {}), \"exemptImages\", [])\n img := container.image\n exemption := exempt_images[_]\n _matches_exemption(img, exemption)\n}\n_matches_exemption(img, exemption) {\n not endswith(exemption, \"*\")\n exemption == img\n}\n_matches_exemption(img, exemption) {\n endswith(exemption, \"*\")\n prefix := trim_suffix(exemption, \"*\")\n startswith(img, prefix)\n}" ] } ] }, "status" : { } } }
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 48 |
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 ShowClusterProtectPolicyTemplateSolution { 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(); ShowClusterProtectPolicyTemplateRequest request = new ShowClusterProtectPolicyTemplateRequest(); request.withPolicyTemplateId("{policy_template_id}"); try { ShowClusterProtectPolicyTemplateResponse response = client.showClusterProtectPolicyTemplate(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 32 |
# 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 = ShowClusterProtectPolicyTemplateRequest() request.policy_template_id = "{policy_template_id}" response = client.show_cluster_protect_policy_template(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 |
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.ShowClusterProtectPolicyTemplateRequest{} request.PolicyTemplateId = "{policy_template_id}" response, err := client.ShowClusterProtectPolicyTemplate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
错误码
请参见错误码。