Method: routers.listRoutePolicies

Retrieves a list of router route policy subresources available to the specified project.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/routers/{router}/listRoutePolicies

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
region

string

Name of the region for this request.
router

string

Name or id of the resource for this request. Name should conform to RFC1035.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter

string

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
orderBy

string

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
returnPartialSuccess

boolean

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "kind": string,
  "id": string,
  "result": [
    {
      "name": string,
      "type": enum,
      "terms": [
        {
          "priority": integer,
          "match": {
            "expression": string,
            "title": string,
            "description": string,
            "location": string
          },
          "actions": [
            {
              "expression": string,
              "title": string,
              "description": string,
              "location": string
            }
          ]
        }
      ],
      "fingerprint": string,
      "description": string
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "etag": string,
  "unreachables": [
    string
  ]
}
Fields
kind

string

[Output Only] Type of resource. Always compute#routersListRoutePolicies for lists of route policies.
id

string

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

object

[Output Only] A list of route policies.
result[].name

string

Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.
result[].type

enum
result[].terms[]

object

routers.list of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.
result[].terms[].priority

integer

The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list.
result[].terms[].match

object

CEL expression evaluated against a route to determine if this term applies. When not set, the term applies to all routes.
result[].terms[].match.expression

string

Textual representation of an expression in Common Expression Language syntax.
result[].terms[].match.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.
result[].terms[].match.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.
result[].terms[].match.location

string

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

object

CEL expressions to evaluate to modify a route when this term matches.
result[].terms[].actions[].expression

string

Textual representation of an expression in Common Expression Language syntax.
result[].terms[].actions[].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.
result[].terms[].actions[].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.
result[].terms[].actions[].location

string

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

string (bytes format)

A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels.

To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.

A base64-encoded string.
result[].description

string

An optional description of route policy.
nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
warning

object

[Output Only] Informational warning message.
warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warning.message

string

[Output Only] A human-readable description of the warning code.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
warning.data[].key

string

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value

string

[Output Only] A warning data value corresponding to the key.
etag

string
unreachables[]

string

[Output Only] Unreachable resources.

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.routers.listRoutePolicies

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