Virtual Private Cloud API, gRPC: SecurityGroupService.Move

Field

Description

security_group_id

string

Required field. ID of the security group to move.

destination_folder_id

string

Required field. ID of the folder to move security group to.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

MoveSecurityGroupMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

SecurityGroup

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

security_group_id

string

ID of the security group that is being moved.

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.