Adding Rules to a Specified Security Group
Function
You can call the API for creating security group rules in batches in a security group.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/vpc/security-groups/{security_group_id}/security-group-rules/batch-create
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
|
security_group_id |
Yes |
String |
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
security_group_rules |
Yes |
Array of BatchCreateSecurityGroupRulesOption objects |
|
ignore_duplicate |
No |
Boolean |
|
dry_run |
No |
Boolean |
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
description |
No |
String |
|
direction |
Yes |
String |
|
ethertype |
No |
String |
|
protocol |
No |
String |
|
multiport |
No |
String |
|
remote_ip_prefix |
No |
String |
|
remote_group_id |
No |
String |
|
remote_address_group_id |
No |
String |
|
action |
No |
String |
|
priority |
No |
String |
|
enabled |
No |
Boolean |
|
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
security_group_rules |
Array of SecurityGroupRule objects |
|
request_id |
String |
|
Parameter |
Type |
Description |
---|---|---|
id |
String |
|
description |
String |
|
security_group_id |
String |
|
direction |
String |
|
protocol |
String |
|
ethertype |
String |
|
multiport |
String |
|
action |
String |
|
priority |
Integer |
|
remote_group_id |
String |
|
remote_ip_prefix |
String |
|
remote_address_group_id |
String |
|
created_at |
String |
|
updated_at |
String |
|
project_id |
String |
|
enabled |
Boolean |
|
Status code: 202
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
|
error_msg |
String |
|
error_code |
String |
|
Example Requests
Adding two inbound rules to the security group whose ID is 15457509-18f9-4387-bae6-d4ed1898b301 with duplicate rules ignored
POST https://{Endpoint}/v3/{project_id}/vpc/security-groups/15457509-18f9-4387-bae6-d4ed1898b301/security-group-rules/batch-create { "ignore_duplicate" : true, "security_group_rules" : [ { "direction" : "ingress", "description" : "", "protocol" : "tcp", "action" : "allow", "priority" : 1, "ethertype" : "IPv4", "multiport" : "22", "remote_ip_prefix" : "117.78.12.122/32" }, { "direction" : "ingress", "description" : "", "protocol" : "tcp", "action" : "allow", "priority" : 1, "ethertype" : "IPv4", "multiport" : "22", "remote_ip_prefix" : "117.78.12.122/32" } ] }
Example Responses
Status code: 201
Normal response to the POST operation. For more status codes, see Status Codes.
-
{ "security_group_rules" : [ { "id" : "abef369b-d646-4b8a-9f44-fcd248a6c421", "project_id" : "5f6387106c2048b589b369d96c2f23a2", "security_group_id" : "15457509-18f9-4387-bae6-d4ed1898b301", "direction" : "ingress", "protocol" : "tcp", "description" : "", "created_at" : "2023-04-28T04:08:52.000+00:00", "updated_at" : "2023-04-28T04:08:52.000+00:00", "ethertype" : "IPv4", "remote_ip_prefix" : "117.78.12.122/32", "multiport" : 22, "action" : "allow", "priority" : 1, "remote_group_id" : null, "remote_address_group_id" : null, "enabled" : true } ], "request_id" : "f1ae2c6f9e94babf077cd3b3e1570c81" }
Status code: 202
Normal response for the specified pre-check request of API V3. For more status codes, see Status Code.
{ "error_msg" : "Request validation has been passed with dry run...", "error_code" : "SYS.0202", "request_id" : "cfd81aea3f59eac7128dba4b36d516c8" }
SDK Sample Code
The SDK sample code is as follows.
Adding two inbound rules to the security group whose ID is 15457509-18f9-4387-bae6-d4ed1898b301 with duplicate rules ignored
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 |
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.vpc.v3.region.VpcRegion; import com.huaweicloud.sdk.vpc.v3.*; import com.huaweicloud.sdk.vpc.v3.model.*; import java.util.List; import java.util.ArrayList; public class BatchCreateSecurityGroupRulesSolution { 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); VpcClient client = VpcClient.newBuilder() .withCredential(auth) .withRegion(VpcRegion.valueOf("<YOUR REGION>")) .build(); BatchCreateSecurityGroupRulesRequest request = new BatchCreateSecurityGroupRulesRequest(); request.withSecurityGroupId("{security_group_id}"); BatchCreateSecurityGroupRulesRequestBody body = new BatchCreateSecurityGroupRulesRequestBody(); List<BatchCreateSecurityGroupRulesOption> listbodySecurityGroupRules = new ArrayList<>(); listbodySecurityGroupRules.add( new BatchCreateSecurityGroupRulesOption() .withDescription("") .withDirection("ingress") .withEthertype("IPv4") .withProtocol("tcp") .withMultiport("22") .withRemoteIpPrefix("117.78.12.122/32") .withAction("allow") .withPriority("1") ); listbodySecurityGroupRules.add( new BatchCreateSecurityGroupRulesOption() .withDescription("") .withDirection("ingress") .withEthertype("IPv4") .withProtocol("tcp") .withMultiport("22") .withRemoteIpPrefix("117.78.12.122/32") .withAction("allow") .withPriority("1") ); body.withIgnoreDuplicate(true); body.withSecurityGroupRules(listbodySecurityGroupRules); request.withBody(body); try { BatchCreateSecurityGroupRulesResponse response = client.batchCreateSecurityGroupRules(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()); } } } |
Adding two inbound rules to the security group whose ID is 15457509-18f9-4387-bae6-d4ed1898b301 with duplicate rules ignored
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkvpc.v3 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 = VpcClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchCreateSecurityGroupRulesRequest() request.security_group_id = "{security_group_id}" listSecurityGroupRulesbody = [ BatchCreateSecurityGroupRulesOption( description="", direction="ingress", ethertype="IPv4", protocol="tcp", multiport="22", remote_ip_prefix="117.78.12.122/32", action="allow", priority="1" ), BatchCreateSecurityGroupRulesOption( description="", direction="ingress", ethertype="IPv4", protocol="tcp", multiport="22", remote_ip_prefix="117.78.12.122/32", action="allow", priority="1" ) ] request.body = BatchCreateSecurityGroupRulesRequestBody( ignore_duplicate=True, security_group_rules=listSecurityGroupRulesbody ) response = client.batch_create_security_group_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Adding two inbound rules to the security group whose ID is 15457509-18f9-4387-bae6-d4ed1898b301 with duplicate rules ignored
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/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 := vpc.NewVpcClient( vpc.VpcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchCreateSecurityGroupRulesRequest{} request.SecurityGroupId = "{security_group_id}" descriptionSecurityGroupRules:= "" ethertypeSecurityGroupRules:= "IPv4" protocolSecurityGroupRules:= "tcp" multiportSecurityGroupRules:= "22" remoteIpPrefixSecurityGroupRules:= "117.78.12.122/32" actionSecurityGroupRules:= "allow" prioritySecurityGroupRules:= "1" descriptionSecurityGroupRules1:= "" ethertypeSecurityGroupRules1:= "IPv4" protocolSecurityGroupRules1:= "tcp" multiportSecurityGroupRules1:= "22" remoteIpPrefixSecurityGroupRules1:= "117.78.12.122/32" actionSecurityGroupRules1:= "allow" prioritySecurityGroupRules1:= "1" var listSecurityGroupRulesbody = []model.BatchCreateSecurityGroupRulesOption{ { Description: &descriptionSecurityGroupRules, Direction: "ingress", Ethertype: ðertypeSecurityGroupRules, Protocol: &protocolSecurityGroupRules, Multiport: &multiportSecurityGroupRules, RemoteIpPrefix: &remoteIpPrefixSecurityGroupRules, Action: &actionSecurityGroupRules, Priority: &prioritySecurityGroupRules, }, { Description: &descriptionSecurityGroupRules1, Direction: "ingress", Ethertype: ðertypeSecurityGroupRules1, Protocol: &protocolSecurityGroupRules1, Multiport: &multiportSecurityGroupRules1, RemoteIpPrefix: &remoteIpPrefixSecurityGroupRules1, Action: &actionSecurityGroupRules1, Priority: &prioritySecurityGroupRules1, }, } ignoreDuplicateBatchCreateSecurityGroupRulesRequestBody:= true request.Body = &model.BatchCreateSecurityGroupRulesRequestBody{ IgnoreDuplicate: &ignoreDuplicateBatchCreateSecurityGroupRulesRequestBody, SecurityGroupRules: listSecurityGroupRulesbody, } response, err := client.BatchCreateSecurityGroupRules(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 |
---|---|
201 |
Normal response to the POST operation. For more status codes, see Status Codes. |
202 |
Normal response for the specified pre-check request of API V3. For more status codes, see Status Code. |
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