Method: instances.getEffectiveFirewalls

Returns effective firewalls applied to an interface of the instance.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/instances/{resourceId}/getEffectiveFirewalls

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

zone

string

The name of the zone for this request.

resourceId

string

Name of the instance scoping this request.

Query parameters

Parameters
networkInterface

string

The name of the network interface to get the effective firewalls.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "firewalls": [
    {
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "network": string,
      "priority": integer,
      "sourceRanges": [
        string
      ],
      "destinationRanges": [
        string
      ],
      "sourceTags": [
        string
      ],
      "targetTags": [
        string
      ],
      "sourceServiceAccounts": [
        string
      ],
      "targetServiceAccounts": [
        string
      ],
      "allowed": [
        {
          "IPProtocol": string,
          "ports": [
            string
          ]
        }
      ],
      "denied": [
        {
          "IPProtocol": string,
          "ports": [
            string
          ]
        }
      ],
      "direction": enum,
      "enableLogging": boolean,
      "logConfig": {
        "enable": boolean,
        "metadata": enum
      },
      "disabled": boolean,
      "selfLink": string,
      "kind": string
    }
  ],
  "organizationFirewalls": [
    {
      "id": string,
      "rules": [
        {
          "description": string,
          "priority": integer,
          "match": {
            "expr": {
              "expression": string,
              "title": string,
              "description": string,
              "location": string
            },
            "versionedExpr": enum,
            "config": {
              "srcIpRanges": [
                string
              ],
              "destIpRanges": [
                string
              ],
              "layer4Configs": [
                {
                  "ipProtocol": string,
                  "ports": [
                    string
                  ]
                }
              ]
            }
          },
          "action": string,
          "preview": boolean,
          "direction": enum,
          "targetResources": [
            string
          ],
          "enableLogging": boolean,
          "ruleTupleCount": integer,
          "targetServiceAccounts": [
            string
          ],
          "kind": string
        }
      ]
    }
  ]
}
Fields
firewalls[]

object

Effective firewalls on the instance.

firewalls[].id

string (fixed64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

firewalls[].creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

firewalls[].name

string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `a-z?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

firewalls[].description

string

An optional description of this resource. Provide this field when you create the resource.

firewalls[].network

string

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:

global/networks/default
If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

firewalls[].priority

integer

Priority for this rule. This is an integer between 0 and 65535, both inclusive. The default value is 1000. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority 0 has higher precedence than a rule with priority 1. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of 65535. To avoid conflicts with the implied rules, use a priority number less than 65535.

firewalls[].sourceRanges[]

string

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.

firewalls[].destinationRanges[]

string

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.

firewalls[].sourceTags[]

string

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

firewalls[].targetTags[]

string

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

firewalls[].sourceServiceAccounts[]

string

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

firewalls[].targetServiceAccounts[]

string

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

firewalls[].allowed[]

object

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

firewalls[].allowed[].IPProtocol

string

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

firewalls[].allowed[].ports[]

string

An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

firewalls[].denied[]

object

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

firewalls[].denied[].IPProtocol

string

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

firewalls[].denied[].ports[]

string

An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

firewalls[].direction

enum

Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For INGRESS traffic, you cannot specify the destinationRanges field, and for EGRESS traffic, you cannot specify the sourceRanges or sourceTags fields.

firewalls[].enableLogging
(deprecated)

boolean

Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.

firewalls[].logConfig

object

This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

firewalls[].logConfig.enable

boolean

This field denotes whether to enable logging for a particular firewall rule.

firewalls[].logConfig.metadata

enum

This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.

firewalls[].disabled

boolean

Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

firewalls[].selfLink

string

[Output Only] Server-defined URL for the resource.

firewalls[].kind

string

[Output Only] Type of the resource. Always compute#firewall for firewall rules.

organizationFirewalls[]

object

Effective firewalls from organization policies.

organizationFirewalls[].id

string (fixed64 format)

The unique identifier for the security policy. This identifier is defined by the server.

organizationFirewalls[].rules[]

object

The rules that apply to the network.

organizationFirewalls[].rules[].description

string

An optional description of this resource. Provide this property when you create the resource.

organizationFirewalls[].rules[].priority

integer

An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

organizationFirewalls[].rules[].match

object

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

organizationFirewalls[].rules[].match.expr

object

User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header.

organizationFirewalls[].rules[].match.expr.expression

string

Textual representation of an expression in Common Expression Language syntax.

organizationFirewalls[].rules[].match.expr.title

string

Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

organizationFirewalls[].rules[].match.expr.description

string

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

organizationFirewalls[].rules[].match.expr.location

string

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

organizationFirewalls[].rules[].match.versionedExpr

enum

Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding srcIpRange field in config.

organizationFirewalls[].rules[].match.config

object

The configuration options available when specifying versionedExpr. This field must be specified if versionedExpr is specified and cannot be specified if versionedExpr is not specified.

organizationFirewalls[].rules[].match.config.srcIpRanges[]

string

CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

organizationFirewalls[].rules[].match.config.destIpRanges[]

string

CIDR IP address range.

This field may only be specified when versionedExpr is set to FIREWALL.

organizationFirewalls[].rules[].match.config.layer4Configs[]

object

Pairs of IP protocols and ports that the rule should match.

This field may only be specified when versionedExpr is set to FIREWALL.

organizationFirewalls[].rules[].match.config.layer4Configs[].ipProtocol

string

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

organizationFirewalls[].rules[].match.config.layer4Configs[].ports[]

string

An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

This field may only be specified when versionedExpr is set to FIREWALL.

organizationFirewalls[].rules[].action

string

The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

organizationFirewalls[].rules[].preview

boolean

If set to true, the specified action is not enforced.

organizationFirewalls[].rules[].direction

enum

The direction in which this rule applies. This field may only be specified when versionedExpr is set to FIREWALL.

organizationFirewalls[].rules[].targetResources[]

string

A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

This field may only be specified when versionedExpr is set to FIREWALL.

organizationFirewalls[].rules[].enableLogging

boolean

Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

This field may only be specified when the versionedExpr is set to FIREWALL.

organizationFirewalls[].rules[].ruleTupleCount

integer

[Output Only] Calculation of the complexity of a single firewall security policy rule.

organizationFirewalls[].rules[].targetServiceAccounts[]

string

A list of service accounts indicating the sets of instances that are applied with this rule.

organizationFirewalls[].rules[].kind

string

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

  • compute.instances.getEffectiveFirewalls

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.