文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器网络隔离信息/ 创建安全组策略 - CreateSecurityGroupPolicy
更新时间:2025-12-26 GMT+08:00
分享

创建安全组策略 - CreateSecurityGroupPolicy

功能介绍

创建安全组策略(云原生网络模型)。

调用方法

请参见如何调用API

授权信息

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

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

URI

POST /v5/{project_id}/container-network/{cluster_id}/{namespace}/security-group-policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

cluster_id

String

集群id

namespace

String

命名空间

表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位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

policy_name

String

策略名称

workload_id

String

工作负载ID

workload_name

String

工作负载名称

workload_type

String

参数解释:

工作负载类型

取值范围:

  • deployments:无状态负载

  • statefulsets:有状态负载

  • daemonsets:守护进程表

security_groups

Array of SecurityGroup objects

安全组列表

表5 SecurityGroup

参数

是否必选

参数类型

描述

security_group_id

String

参数解释

云原生网络模型中安全组的唯一标识,用于关联具体安全组到策略

约束限制

安全组需与集群处于同一VPC网络,否则关联失败

取值范围

字符长度1-64位,支持字母、数字、短横线(-)、下划线(_)

默认取值

security_group_name

String

参数解释

安全组的名称,用于辅助标识安全组,仅作展示用途

约束限制

若传入该参数,需与security_group_id对应的安全组名称一致,否则可能导致展示异常(不影响功能)

取值范围

字符长度1-64位,支持中文、英文、数字、短横线(-)、下划线(_)

默认取值

无,默认使用安全组ID对应的系统名称

security_group_description

String

参数解释

安全组的描述信息,用于记录安全组的用途、权限范围等备注

约束限制

描述内容不能包含HTML标签等特殊字符

取值范围

字符长度0-256位,支持中文、英文、数字、常用标点符号及空格

默认取值

无,不修改安全组描述(若原有描述为空则保持为空)

响应参数

状态码:200

请求已成功

请求示例

创建安全组策略(云原生网络模型)

POST https://{endpoint}/v5/{project_id}/container-network/{cluster_id}/{namespace}/security-group-policy?enterprise_project_id=all_granted_eps

{
  "policy_name" : "ywk-test",
  "workload_id" : "27f3d7af-e947-4731-a3d2-8a561ae33069",
  "workload_name" : "kube-state-metrics",
  "workload_type" : "deployments",
  "security_groups" : [ {
    "security_group_id" : "03b46bce-b0b7-42d3-992d-ddfb567106f0",
    "security_group_name" : "sg-4a7d"
  } ]
}

响应示例

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
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 CreateSecurityGroupPolicySolution {

    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();
        CreateSecurityGroupPolicyRequest request = new CreateSecurityGroupPolicyRequest();
        request.withClusterId("{cluster_id}");
        request.withNamespace("{namespace}");
        CreateSecurityGroupPolicyRequestBody body = new CreateSecurityGroupPolicyRequestBody();
        List<SecurityGroup> listbodySecurityGroups = new ArrayList<>();
        listbodySecurityGroups.add(
            new SecurityGroup()
                .withSecurityGroupId("03b46bce-b0b7-42d3-992d-ddfb567106f0")
                .withSecurityGroupName("sg-4a7d")
        );
        body.withSecurityGroups(listbodySecurityGroups);
        body.withWorkloadType("deployments");
        body.withWorkloadName("kube-state-metrics");
        body.withWorkloadId("27f3d7af-e947-4731-a3d2-8a561ae33069");
        body.withPolicyName("ywk-test");
        request.withBody(body);
        try {
            CreateSecurityGroupPolicyResponse response = client.createSecurityGroupPolicy(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
# 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 = CreateSecurityGroupPolicyRequest()
        request.cluster_id = "{cluster_id}"
        request.namespace = "{namespace}"
        listSecurityGroupsbody = [
            SecurityGroup(
                security_group_id="03b46bce-b0b7-42d3-992d-ddfb567106f0",
                security_group_name="sg-4a7d"
            )
        ]
        request.body = CreateSecurityGroupPolicyRequestBody(
            security_groups=listSecurityGroupsbody,
            workload_type="deployments",
            workload_name="kube-state-metrics",
            workload_id="27f3d7af-e947-4731-a3d2-8a561ae33069",
            policy_name="ywk-test"
        )
        response = client.create_security_group_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
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.CreateSecurityGroupPolicyRequest{}
	request.ClusterId = "{cluster_id}"
	request.Namespace = "{namespace}"
	securityGroupNameSecurityGroups:= "sg-4a7d"
	var listSecurityGroupsbody = []model.SecurityGroup{
        {
            SecurityGroupId: "03b46bce-b0b7-42d3-992d-ddfb567106f0",
            SecurityGroupName: &securityGroupNameSecurityGroups,
        },
    }
	request.Body = &model.CreateSecurityGroupPolicyRequestBody{
		SecurityGroups: listSecurityGroupsbody,
		WorkloadType: "deployments",
		WorkloadName: "kube-state-metrics",
		WorkloadId: "27f3d7af-e947-4731-a3d2-8a561ae33069",
		PolicyName: "ywk-test",
	}
	response, err := client.CreateSecurityGroupPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档