新建集群防护策略
功能介绍
新建集群防护策略
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/cluster-protect/policy
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
policy_name |
是 |
String |
策略名称 |
policy_id |
是 |
String |
策略ID |
template_id |
是 |
String |
模板ID |
policy_description |
是 |
String |
策略描述 |
content |
是 |
PolicyContent object |
策略内容 |
white_image_list |
是 |
Array of WhiteImageInfo objects |
白名单镜像 |
resources |
是 |
Array of PolicyProtectScope objects |
防护的资源信息 |
parameters |
是 |
String |
策略参数值 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enable_image_startup |
是 |
Boolean |
是否允许未扫描镜像启动 |
policy_type |
是 |
String |
告警策略:
|
severity |
是 |
Integer |
风险等级 |
risky_item |
是 |
Array of strings |
危险项 |
action |
是 |
Integer |
防护动作
|
响应参数
状态码:200
请求已成功
无
请求示例
新建集群防护策略
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" ] } ] }
响应示例
无
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 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()); } } } |
新建集群防护策略
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) |
新建集群防护策略
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
错误码
请参见错误码。