更新安全组策略 - UpdateSecurityGroupPolicy
功能介绍
更新安全组策略(云原生网络模型)。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v5/{project_id}/container-network/{cluster_id}/{namespace}/security-group-policy
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
cluster_id |
是 |
String |
参数解释 Kubernetes集群的唯一标识,用于指定更新安全组策略所属的集群 约束限制 需确保集群已接入HSS服务,且账号拥有该集群的操作权限 取值范围 字符长度1-64位,支持字母、数字、短横线(-)、下划线(_) 默认取值 无 |
|
namespace |
是 |
String |
参数解释 Kubernetes集群内的命名空间标识,用于隔离不同命名空间下的安全组策略 约束限制 命名空间需已存在于指定集群中,否则返回资源不存在错误 取值范围 字符长度1-63位,支持字母、数字、短横线(-),且不能以短横线开头或结尾 默认取值 无 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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_id |
是 |
String |
参数解释 安全组策略的唯一标识,用于指定待更新的目标安全组策略 约束限制 需确保该策略已存在于指定集群和命名空间下,否则返回策略不存在错误 取值范围 字符长度1-64位,支持UUID格式(32位十六进制字符,含4个短横线分隔) 默认取值 无 |
|
policy_name |
否 |
String |
参数解释 安全组策略的名称,用于标识策略用途,更新时可修改该名称 约束限制 名称不能包含特殊字符(如@、#、$等),且同一命名空间下策略名称建议唯一 取值范围 字符长度1-64位,支持中文、英文、数字、短横线(-)、下划线(_) 默认取值 无,不修改策略名称 |
|
security_groups |
是 |
Array of SecurityGroup objects |
参数解释 待关联到安全组策略的安全组集合,更新后策略将仅应用于该列表中的安全组 约束限制 数组不能为空(至少包含1个安全组),且安全组需已存在于当前项目/企业项目下 取值范围 数组长度1-20个元素,每个元素需符合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
接口更新成功后无返回体数据,仅通过200状态码标识更新成功;若更新失败,将返回对应错误码及错误信息,详见错误码章节。
无
请求示例
更新安全组策略(云原生网络模型)
PUT https://{endpoint}/v5/{project_id}/container-network/{cluster_id}/{namespace}/security-group-policy?enterprise_project_id=all_granted_eps
{
"policy_id" : "501830f7-a182-41ea-a9ae-10973410eca6",
"policy_name" : "ywk-test",
"security_groups" : [ {
"security_group_id" : "090cef69-1b90-4f86-9e10-ba593811fcf4",
"security_group_name" : "sg-df44"
}, {
"security_group_id" : "110a7b73-7fae-4c28-bae8-535f6a853613",
"security_group_name" : "hss-test-block"
} ]
}
响应示例
无
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 |
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 UpdateSecurityGroupPolicySolution { 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(); UpdateSecurityGroupPolicyRequest request = new UpdateSecurityGroupPolicyRequest(); request.withClusterId("{cluster_id}"); request.withNamespace("{namespace}"); UpdateSecurityGroupPolicyRequestBody body = new UpdateSecurityGroupPolicyRequestBody(); List<SecurityGroup> listbodySecurityGroups = new ArrayList<>(); listbodySecurityGroups.add( new SecurityGroup() .withSecurityGroupId("090cef69-1b90-4f86-9e10-ba593811fcf4") .withSecurityGroupName("sg-df44") ); listbodySecurityGroups.add( new SecurityGroup() .withSecurityGroupId("110a7b73-7fae-4c28-bae8-535f6a853613") .withSecurityGroupName("hss-test-block") ); body.withSecurityGroups(listbodySecurityGroups); body.withPolicyName("ywk-test"); body.withPolicyId("501830f7-a182-41ea-a9ae-10973410eca6"); request.withBody(body); try { UpdateSecurityGroupPolicyResponse response = client.updateSecurityGroupPolicy(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 |
# 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 = UpdateSecurityGroupPolicyRequest() request.cluster_id = "{cluster_id}" request.namespace = "{namespace}" listSecurityGroupsbody = [ SecurityGroup( security_group_id="090cef69-1b90-4f86-9e10-ba593811fcf4", security_group_name="sg-df44" ), SecurityGroup( security_group_id="110a7b73-7fae-4c28-bae8-535f6a853613", security_group_name="hss-test-block" ) ] request.body = UpdateSecurityGroupPolicyRequestBody( security_groups=listSecurityGroupsbody, policy_name="ywk-test", policy_id="501830f7-a182-41ea-a9ae-10973410eca6" ) response = client.update_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 54 55 56 57 |
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.UpdateSecurityGroupPolicyRequest{} request.ClusterId = "{cluster_id}" request.Namespace = "{namespace}" securityGroupNameSecurityGroups:= "sg-df44" securityGroupNameSecurityGroups1:= "hss-test-block" var listSecurityGroupsbody = []model.SecurityGroup{ { SecurityGroupId: "090cef69-1b90-4f86-9e10-ba593811fcf4", SecurityGroupName: &securityGroupNameSecurityGroups, }, { SecurityGroupId: "110a7b73-7fae-4c28-bae8-535f6a853613", SecurityGroupName: &securityGroupNameSecurityGroups1, }, } policyNameUpdateSecurityGroupPolicyRequestBody:= "ywk-test" request.Body = &model.UpdateSecurityGroupPolicyRequestBody{ SecurityGroups: listSecurityGroupsbody, PolicyName: &policyNameUpdateSecurityGroupPolicyRequestBody, PolicyId: "501830f7-a182-41ea-a9ae-10973410eca6", } response, err := client.UpdateSecurityGroupPolicy(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
接口更新成功后无返回体数据,仅通过200状态码标识更新成功;若更新失败,将返回对应错误码及错误信息,详见错误码章节。 |
错误码
请参见错误码。