Contact UsGet started

Virtual Private Cloud API, gRPC: SecurityGroupService.Get

Written by
Updated at December 17, 2024

Returns the specified SecurityGroup resource.

To get the list of all available SecurityGroup resources, make a List request.

gRPC request

rpc Get (GetSecurityGroupRequest) returns (SecurityGroup)

GetSecurityGroupRequest

{
  "security_group_id": "string"
}

Field

Description

security_group_id

string

Required field. ID of the Security Group resource to return.
To get the security group ID, use a [SecurityGroup.List] request.

SecurityGroup

{
  "id": "string",
  "folder_id": "string",
  "created_at": "google.protobuf.Timestamp",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "network_id": "string",
  "status": "Status",
  "rules": [
    {
      "id": "string",
      "description": "string",
      "labels": "map<string, string>",
      "direction": "Direction",
      "ports": {
        "from_port": "int64",
        "to_port": "int64"
      },
      "protocol_name": "string",
      "protocol_number": "int64",
      // Includes only one of the fields `cidr_blocks`, `security_group_id`, `predefined_target`
      "cidr_blocks": {
        "v4_cidr_blocks": [
          "string"
        ],
        "v6_cidr_blocks": [
          "string"
        ]
      },
      "security_group_id": "string",
      "predefined_target": "string"
      // end of the list of possible fields
    }
  ],
  "default_for_network": "bool"
}

Field

Description

id

string

ID of the security group.

folder_id

string

ID of the folder that the security group belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

name

string

Name of the security group.
The name must be unique within the folder.
Value must match the regular expression \\|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description

string

Description of the security group. 0-256 characters long.

labels

object (map<string, string>)

Resource labels as key:value pairs.
No more than 64 per resource.
The maximum string length in characters for each value is 63.
Each value must match the regular expression [-_./\\@0-9a-z]*.
The string length in characters for each key must be 1-63.
Each key must match the regular expression [a-z][-_./\\@0-9a-z]*.

network_id

string

ID of the network that the security group belongs to.

status

enum Status

Security group status.

  • STATUS_UNSPECIFIED
  • CREATING: Security group is being created.
  • ACTIVE: Security is active and it's rules are applied to the network interfaces.
  • UPDATING: Security group is updating. Updating is a long operation because we must update all instances in SG.
  • DELETING: Instance is being deleted.

rules[]

SecurityGroupRule

List of the security group rules.

default_for_network

bool

Flag that indicates that the security group is the default for the network.

SecurityGroupRule

Field

Description

id

string

ID of the rule.

description

string

Description of the rule. 0-256 characters long.

labels

object (map<string, string>)

Resource labels as key:value pairs. Maximum of 64 per resource.

direction

enum Direction

Required field. The direction of network traffic allowed by this rule.

  • DIRECTION_UNSPECIFIED
  • INGRESS: Allows ingress traffic.
  • EGRESS: Allows egress traffic.

ports

PortRange

The range of ports that allow traffic to pass through. Null value means any.

protocol_name

string

Protocol name. Null value means any protocol.
Values from IANA.

protocol_number

int64

Protocol number from IANA protocol numbers.

cidr_blocks

CidrBlocks

CIDR blocks to allow to recieve or send traffic.

Includes only one of the fields cidr_blocks, security_group_id, predefined_target.

security_group_id

string

ID of the security group to add rule to.

Includes only one of the fields cidr_blocks, security_group_id, predefined_target.

predefined_target

string

Predefined target. See security groups rules for more information.

Includes only one of the fields cidr_blocks, security_group_id, predefined_target.

PortRange

Field

Description

from_port

int64

The lowest port in the range.

to_port

int64

The highest port in the range.

CidrBlocks

Field

Description

v4_cidr_blocks[]

string

IPv4 CIDR blocks to allow traffic to.

v6_cidr_blocks[]

string

IPv6 CIDR blocks to allow traffic to.
Previous
Overview
Next
List