Method: projects.locations.tcpRoutes.list

指定されたプロジェクトとロケーションの TcpRoute を一覧表示します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。TcpRoute を一覧表示するプロジェクトとロケーション。projects/*/locations/global の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • networkservices.tcpRoutes.list

クエリ パラメータ

パラメータ
pageSize

integer

呼び出しごとに返される TcpRoute の最大数。
pageToken

string

最後の ListTcpRoutesResponse で返された値は、これが前の tcpRoutes.list 呼び出しの続きであり、システムからその次のページのデータが返される必要があることを示しています。
returnPartialSuccess

boolean

省略可。true に設定すると、マルチリージョンの集約リスト リクエストに対して部分レスポンスを許可します。true に設定しておらず、いずれかのロケーションが停止している場合や到達できない場合、集約リスト リクエストは失敗します。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

tcpRoutes.list メソッドによって返されるレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "tcpRoutes": [
    {
      object (TcpRoute)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
フィールド
tcpRoutes[]

object (TcpRoute)

TcpRoute リソースのリスト。
nextPageToken

string

このレスポンスよりも結果が多い可能性がある場合には、nextPageToken が含まれます。次の結果セットを取得するには、pageToken として nextPageToken の値を使用して、このメソッドを再度呼び出します。
unreachable[]

string

到達不可能なリソース。リクエストで returnPartialSuccess が有効になり、コレクション全体で読み取られるときに入力されます（サポートされているすべてのロケーションのすべてのリソースを一覧表示しようとした場合など）。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。