Method: instances.getEffectiveFirewalls

Returns effective firewalls applied to an interface of the instance.

HTTP request

GET https://compute.s3nsapis.fr/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

Path parameters

Parameters
project

string

Project ID for this request.

zone

string

The name of the zone for this request.

instance

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": [
    {
      object (Firewall)
    }
  ],
  "firewallPolicys": [
    {
      object (EffectiveFirewallPolicy)
    }
  ]
}
Fields
firewalls[]

object (Firewall)

Effective firewalls on the instance.

firewallPolicys[]

object (EffectiveFirewallPolicy)

[Output Only] Effective firewalls from firewall policies.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • 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.

EffectiveFirewallPolicy

JSON representation
{
  "name": string,
  "type": enum (Type),
  "shortName": string,
  "displayName": string,
  "rules": [
    {
      object (Rule)
    }
  ],
  "packetMirroringRules": [
    {
      object (Rule)
    }
  ],
  "priority": integer
}
Fields
name

string

[Output Only] The name of the firewall policy.

type

enum (Type)

[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.

shortName

string

[Output Only] The short name of the firewall policy.

displayName
(deprecated)

string

[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.

rules[]

object (Rule)

[Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules.

packetMirroringRules[]

object (Rule)

[Output Only] The packet mirroring rules that apply to the instance.

priority

integer

[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.

Type

Enums
UNSPECIFIED
HIERARCHY
NETWORK
NETWORK_REGIONAL
SYSTEM_GLOBAL
SYSTEM_REGIONAL