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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: ID of the project that a security group rule belongs to. For details about how to obtain a project ID, see Obtaining a Project ID. Range: None

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
dry_run	No	Boolean	Definition: Whether to only send the check request. Constraints: None Range: true: A check request will be sent and no security group rule will be created. Check items include mandatory parameters, request format, and constraints. If the check fails, an error will be returned. If the check succeeds, response code 202 will be returned. false: A request will be sent and a security group rule will be created. Default Value: false
security_group_rule	Yes	CreateSecurityGroupRuleOption object	Definition: Request body for creating a security group rule. Constraints: None Range: None Default Value: None

**Table 3** CreateSecurityGroupRuleOption
Parameter	Mandatory	Type	Description
security_group_id	Yes	String	Definition: ID of the security group that a security group rule belongs to. Constraints: None Range: None Default Value: None
description	No	String	Definition: Description of a security group rule. Constraints: The value can contain no more than 255 characters and cannot contain angle brackets (< or >). Range: None Default Value: None
direction	Yes	String	Definition: Inbound or outbound direction of a security group rule. Constraints: None Range: ingress: inbound direction egress: outbound direction Default Value: None
ethertype	No	String	Definition: IP address version of a security group rule. Constraints: None Range: IPv4 IPv6 Default Value: IPv4
protocol	No	String	Definition: Communication protocol of a security group rule. Constraints: If the parameter is left blank, all protocols are supported. If the protocol is icmpv6, IP version should be IPv6. If the protocol is icmp, IP version should be IPv4. Range: icmp tcp udp icmpv6 IP protocol number (0-255) Default Value: None
multiport	No	String	Definition: Port range of a security group rule. Constraints: The port number ranges from 1 to 65535. Range: The value can be a single port (80), a port range (1-30), or inconsecutive ports separated by commas (22,3389,80). Default Value: None
remote_ip_prefix	No	String	Definition: Remote IP address of a security group rule. If direction is set to egress, this address is the outbound destination and will be accessed by instances in the security group. If direction is set to ingress, this address is the inbound source and will access instances in the security group. Constraints: This parameter is mutually exclusive with parameters remote_group_id and remote_address_group_id. If this parameter is left blank, traffic from all remote IP addresses is allowed when the action of the rule is allow, and is denied when the action of the rule is deny. Range: IP address. If an IP address is specified in the request, the IP address is automatically formatted with /32 as the subnet mask, for example, 192.168.21.45/32. The value must be in CIDR format. Default Value: None
remote_group_id	No	String	Definition: ID of the remote security group of a security group rule. If the action of the rule is allow, the traffic from the remote security group is allowed. If the action of the rule is deny, the traffic from the remote security group is denied. Constraints: The parameter is mutually exclusive with parameters remote_ip_prefix and remote_address_group_id. Range: ID of an existing security group. Default Value: None
remote_address_group_id	No	String	Definition: ID of the remote IP address group of a security group rule. Constraints: The parameter is mutually exclusive with parameters remote_ip_prefix and remote_group_id. Range: ID of an existing IP address group. Default Value: None
action	No	String	Definition: Action of a security group rule. Constraints: None Range: allow deny Default Value: allow
priority	No	String	Definition: Priority of a security group rule. Constraints: None Range: The value is from 1 to 100. The value 1 indicates the highest priority. Default Value: 1

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Definition: Request ID. Range: None
security_group_rule	SecurityGroupRule object	Definition: Response body for creating a security group rule. Range: None

**Table 5** SecurityGroupRule
Parameter	Type	Description
id	String	Definition: ID of a security group rule. After a security group rule is created, a security group rule ID is generated, which uniquely identifies the security group rule. Range: The value is in UUID format with hyphens (-).
description	String	Definition: Description of a security group rule. Range: The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
security_group_id	String	Definition: ID of the security group that a security group rule belongs to. Range: None
direction	String	Definition: Inbound or outbound direction of a security group rule. Range: ingress: inbound direction egress: outbound direction
protocol	String	Definition: Communication protocol of a security group rule. Range: icmp tcp udp icmpv6 IP protocol number
ethertype	String	Definition: IP address version of a security group rule. Range: IPv4 IPv6
multiport	String	Definition: Port range of a security group rule. Range: The value can be a single port (80), a port range (1-30), or inconsecutive ports separated by commas (22,3389,80).
action	String	Definition: Action of a security group rule. Range: allow deny
priority	Integer	Definition: Priority of a security group rule. Range: The value is from 1 to 100. The value 1 indicates the highest priority.
remote_group_id	String	Definition: ID of the remote security group of a security group rule. If the action of the rule is allow, the traffic from the remote security group is allowed. If the action of the rule is deny, the traffic from the remote security group is denied. Range: ID of an existing security group.
remote_ip_prefix	String	Definition: Remote IP address of a security group rule. If direction is set to egress, the IP address is the outbound destination and will be accessed by instances in the security group. If direction is set to ingress, the IP address is the inbound source and will access the instances in the security group. Range: CIDR notation format. If an IP address is transferred in the request, the IP address is automatically formatted with /32 as the subnet mask, for example, 192.168.21.45/32.
remote_address_group_id	String	Definition: ID of the remote IP address group of a security group rule. Range: ID of an existing IP address group.
created_at	String	Definition: Time when a security group rule was created. Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ
updated_at	String	Definition: Time when a security group rule was updated. Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ
project_id	String	Definition: ID of the project that a security group rule belongs to. Range: None

Status code: 202

**Table 6** Response body parameters
Parameter	Type	Description
request_id	String	Definition: Request ID. Range: None
error_msg	String	Definition: Error message. Range: None
error_code	String	Definition: Error code. Range: None

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
  }
}

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"
}

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.