Creating a Security Group Policy
Function
This API is used to create a security group policy (for the cloud native network model).
Calling Method
For details, see Calling APIs.
URI
POST /v5/{project_id}/container-network/{cluster_id}/{namespace}/security-group-policy
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
cluster_id |
Yes |
String |
Cluster ID |
namespace |
Yes |
String |
Namespaces |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
policy_name |
Yes |
String |
Policy Name |
workload_id |
Yes |
String |
Workload ID |
workload_name |
Yes |
String |
Workload name |
workload_type |
Yes |
String |
Workload Type |
security_groups |
Yes |
Array of SecurityGroup objects |
Security group list |
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
This API is used to create a security group policy (for the cloud native network model).
POST https://{endpoint}/v5/{project_id}/container-network/{cluster_id}/{namespace}/security-group-policy?enterprise_project_id=all_granted_eps
{
"policy_id" : "",
"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"
} ]
}
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
This API is used to create a security group policy (for the cloud native network model).
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());
}
}
}
|
This API is used to create a security group policy (for the cloud native network model).
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)
|
This API is used to create a security group policy (for the cloud native network model).
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)
}
}
|
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
This API is used to create a security group policy (for the cloud native network model).
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());
}
}
}
|
This API is used to create a security group policy (for the cloud native network model).
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)
|
This API is used to create a security group policy (for the cloud native network model).
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)
}
}
|
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot