Virtual Private Cloud API, gRPC: NetworkService.ListSecurityGroups

Field

Description

network_id

string

Required field. ID of the Network resource to list security groups for.

page_size

int64

The maximum number of results per page that should be returned. If the number of available
results is larger than page_size,
the service returns a ListNetworkSecurityGroupsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests. Default value: 100.

page_token

string

Page token. Set page_token
to the ListNetworkSecurityGroupsResponse.next_page_token
returned by a previous list request to get the next page of results.

Field

Description

security_groups[]

SecurityGroup

List of security groups that belong to the network which is specified in the request.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListNetworkSecurityGroupsRequest.page_size, use
the next_page_token as the value
for the ListNetworkSecurityGroupsRequest.page_token query parameter
in the next list request. Subsequent list requests will have their own
next_page_token to continue paging through the results.

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.

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.

Field

Description

from_port

int64

The lowest port in the range.

to_port

int64

The highest port in the range.

Field

Description

v4_cidr_blocks[]

string

IPv4 CIDR blocks to allow traffic to.

v6_cidr_blocks[]

string

IPv6 CIDR blocks to allow traffic to.