Contact UsGet started

Virtual Private Cloud API, gRPC: SecurityGroupService.UpdateRule

Written by
Updated at December 17, 2024

Updates the specified rule.

gRPC request

rpc UpdateRule (UpdateSecurityGroupRuleRequest) returns (operation.Operation)

UpdateSecurityGroupRuleRequest

{
  "security_group_id": "string",
  "rule_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "description": "string",
  "labels": "map<string, string>"
}

Field

Description

security_group_id

string

Required field. ID of the SecurityGroup to update rule in.

rule_id

string

Required field. ID of the rule to update.

update_mask

google.protobuf.FieldMask

Field mask that specifies which attributes of the Address should be updated.

description

string

New description of the rule.

labels

object (map<string, string>)

Rule labels as key:value pairs.

Existing set of labels is completely replaced by the provided set, so if you just want
to add or remove a label:

  1. Get the current set of labels with a AddressService.Get request.
  2. Add or remove a label in this set.
  3. Send the new set in this field.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "security_group_id": "string",
    "rule_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "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
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

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

UpdateSecurityGroupRuleMetadata

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

SecurityGroupRule

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.

UpdateSecurityGroupRuleMetadata

Field

Description

security_group_id

string

ID of the SecurityGroup that is being updated with new rules.

rule_id

string

ID of the rule that is being updated.

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
UpdateRules
Next
Delete