Method: projects.locations.tcpRoutes.list

Lists TcpRoute in a given project and location.

HTTP request

GET https://networkservices.googleapis.com/v1beta1/{parent=projects/*/locations/*}/tcpRoutes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The project and location from which the TcpRoutes should be listed, specified in the format projects/*/locations/global.

Authorization requires the following IAM permission on the specified resource parent:

  • networkservices.tcpRoutes.list

Query parameters

Parameters
pageSize

integer

Maximum number of TcpRoutes to return per call.
pageToken

string

The value returned by the last ListTcpRoutesResponse Indicates that this is a continuation of a prior tcpRoutes.list call, and that the system should return the next page of data.
returnPartialSuccess

boolean

Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.

Request body

The request body must be empty.

Response body

Response returned by the tcpRoutes.list method.

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

JSON representation 
{
  "tcpRoutes": [
    {
      object (TcpRoute)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
tcpRoutes[]

object (TcpRoute)

List of TcpRoute resources.
nextPageToken

string

If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
unreachable[]

string

Unreachable resources. Populated when the request opts into returnPartialSuccess and reading across collections e.g. when attempting to list all resources across all supported locations.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.