- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
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 |
Project ID for this request. |
region |
Name of the region for this request. |
router |
Name or id of the resource for this request. Name should conform to RFC1035. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
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 For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the
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 You cannot combine constraints on multiple fields using regular expressions. |
orderBy |
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 Currently, only sorting by |
returnPartialSuccess |
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 |
[Output Only] Type of resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
result[] |
[Output Only] A list of route policies. |
result[].name |
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 |
|
result[].terms[] |
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 |
The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list. |
result[].terms[].match |
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 |
Textual representation of an expression in Common Expression Language syntax. |
result[].terms[].match.title |
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 |
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 |
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[] |
CEL expressions to evaluate to modify a route when this term matches. |
result[].terms[].actions[].expression |
Textual representation of an expression in Common Expression Language syntax. |
result[].terms[].actions[].title |
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 |
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 |
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
result[].fingerprint |
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 A base64-encoded string. |
result[].description |
An optional description of route policy. |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[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 |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
etag |
|
unreachables[] |
[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.