Creating a Security Group Rule
Function
A security group has inbound and outbound rules to control traffic that is allowed to reach or leave the instances associated with the security group.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/vpc/security-group-rules
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dry_run |
No |
Boolean |
|
security_group_rule |
Yes |
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
security_group_id |
Yes |
String |
|
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 |
---|---|---|
request_id |
String |
|
security_group_rule |
SecurityGroupRule object |
|
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
Create an inbound rule in the security group whose ID is 0552091e-b83a-49dd-88a7-4a5c86fd9ec3.
POST https://{Endpoint}/v3/{project_id}/vpc/security-group-rules { "security_group_rule" : { "security_group_id" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3", "direction" : "ingress", "protocol" : "tcp", "description" : "security group rule description", "action" : "allow", "priority" : 1, "multiport" : "33", "remote_ip_prefix" : "10.10.0.0/16" } }
Example Responses
Status code: 201
Normal response to the POST operation. For more status codes, see Status Codes.
-
{ "request_id" : "1666b2708aaf849337572d6846dce781", "security_group_rule" : { "id" : "f626eb24-d8bd-4d26-ae0b-c16bb65730cb", "project_id" : "060576782980d5762f9ec014dd2f1148", "security_group_id" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3", "direction" : "ingress", "protocol" : "tcp", "description" : "security group rule description", "created_at" : "2020-08-13T07:12:36.000+00:00", "updated_at" : "2020-08-13T07:12:36.000+00:00", "ethertype" : "IPv4", "remote_ip_prefix" : "10.10.0.0/16", "multiport" : 33, "action" : "allow", "priority" : 1, "remote_group_id" : null, "remote_address_group_id" : null, "enabled" : true } }
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.
Create an inbound rule in the security group whose ID is 0552091e-b83a-49dd-88a7-4a5c86fd9ec3.
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 |
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.*; public class CreateSecurityGroupRuleSolution { 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(); CreateSecurityGroupRuleRequest request = new CreateSecurityGroupRuleRequest(); CreateSecurityGroupRuleRequestBody body = new CreateSecurityGroupRuleRequestBody(); CreateSecurityGroupRuleOption securityGroupRulebody = new CreateSecurityGroupRuleOption(); securityGroupRulebody.withSecurityGroupId("0552091e-b83a-49dd-88a7-4a5c86fd9ec3") .withDescription("security group rule description") .withDirection("ingress") .withProtocol("tcp") .withMultiport("33") .withRemoteIpPrefix("10.10.0.0/16") .withAction("allow") .withPriority("1"); body.withSecurityGroupRule(securityGroupRulebody); request.withBody(body); try { CreateSecurityGroupRuleResponse response = client.createSecurityGroupRule(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()); } } } |
Create an inbound rule in the security group whose ID is 0552091e-b83a-49dd-88a7-4a5c86fd9ec3.
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 |
# 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 = CreateSecurityGroupRuleRequest() securityGroupRulebody = CreateSecurityGroupRuleOption( security_group_id="0552091e-b83a-49dd-88a7-4a5c86fd9ec3", description="security group rule description", direction="ingress", protocol="tcp", multiport="33", remote_ip_prefix="10.10.0.0/16", action="allow", priority="1" ) request.body = CreateSecurityGroupRuleRequestBody( security_group_rule=securityGroupRulebody ) response = client.create_security_group_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Create an inbound rule in the security group whose ID is 0552091e-b83a-49dd-88a7-4a5c86fd9ec3.
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 |
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.CreateSecurityGroupRuleRequest{} descriptionSecurityGroupRule:= "security group rule description" protocolSecurityGroupRule:= "tcp" multiportSecurityGroupRule:= "33" remoteIpPrefixSecurityGroupRule:= "10.10.0.0/16" actionSecurityGroupRule:= "allow" prioritySecurityGroupRule:= "1" securityGroupRulebody := &model.CreateSecurityGroupRuleOption{ SecurityGroupId: "0552091e-b83a-49dd-88a7-4a5c86fd9ec3", Description: &descriptionSecurityGroupRule, Direction: "ingress", Protocol: &protocolSecurityGroupRule, Multiport: &multiportSecurityGroupRule, RemoteIpPrefix: &remoteIpPrefixSecurityGroupRule, Action: &actionSecurityGroupRule, Priority: &prioritySecurityGroupRule, } request.Body = &model.CreateSecurityGroupRuleRequestBody{ SecurityGroupRule: securityGroupRulebody, } response, err := client.CreateSecurityGroupRule(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