Method: securityPolicies.getRule

Gets a rule at the specified priority.

HTTP request

GET https://www.googleapis.com/compute/beta/projects/{project}/global/securityPolicies/{resourceId}/getRule

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

resourceId

string

Name of the security policy to which the queried rule belongs.

Query parameters

Parameters
priority

number

The priority of the rule to get from the security policy.

Request body

The request body must be empty.

Response body

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

Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

JSON representation
{
  "description": string,
  "priority": number,
  "match": {
    "expr": {
      "expression": string,
      "title": string,
      "description": string,
      "location": string
    },
    "versionedExpr": enum,
    "config": {
      "srcIpRanges": [
        string
      ]
    },
    "srcIpRanges": [
      string
    ]
  },
  "action": string,
  "preview": boolean,
  "kind": string
}
Fields
description

string

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

priority

number

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 in the increasing order of priority.

match

object

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

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.

match.expr.expression

string

Textual representation of an expression in Common Expression Language syntax.

The application context of the containing message determines which well-known feature set of CEL is supported.

match.expr.title

string

An 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.

match.expr.description

string

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

match.expr.location

string

An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

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.

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.

match.config.srcIpRanges[]

string

CIDR IP address range.

match.srcIpRanges[]

string

CIDR IP address range.

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.

preview

boolean

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

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 Google IAM permissions:

  • compute.securityPolicies.get
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine