Lists the peering routes exchanged over peering connection.
Arguments
Parameters | |
---|---|
network |
Required. Name of the network for this request.
|
project |
Required. Project ID for this request.
|
direction |
The direction of the exchanged routes.
|
Enum type. Can be one of the following: | |
INCOMING |
For routes exported from peer network. |
OUTGOING |
For routes exported from local network. |
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. 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
|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than
|
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
|
pageToken |
Specifies a page token to use. Set
|
peeringName |
The response will show routes exchanged over the given peering connection.
|
region |
The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region.
|
returnPartialSuccess |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
|
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of ExchangedPeeringRoutesList
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- listPeeringRoutes: call: googleapis.compute.v1.networks.listPeeringRoutes args: network: ... project: ... direction: ... filter: ... maxResults: ... orderBy: ... pageToken: ... peeringName: ... region: ... returnPartialSuccess: ... result: listPeeringRoutesResult
JSON
[ { "listPeeringRoutes": { "call": "googleapis.compute.v1.networks.listPeeringRoutes", "args": { "network": "...", "project": "...", "direction": "...", "filter": "...", "maxResults": "...", "orderBy": "...", "pageToken": "...", "peeringName": "...", "region": "...", "returnPartialSuccess": "..." }, "result": "listPeeringRoutesResult" } } ]