Method: projects.locations.agentGateways.list

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

HTTP リクエスト

GET https://networkservices.googleapis.com/v1/{parent=projects/*/locations/*}/agentGateways

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

パスパラメータ

パラメータ
parent

string

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

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

  • iam.permissions.none

クエリ パラメータ

パラメータ
pageSize

integer

省略可。1 回の呼び出しで返される AgentGateway の最大数。
pageToken

string

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

boolean

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

リクエストの本文

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

レスポンスの本文

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

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

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

object (AgentGateway)

AgentGateway リソースのリスト。
nextPageToken

string

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

string

到達できないリソース。サポートされているすべてのロケーションのすべてのリソースの一覧をリクエストによって作成しようとしたときに、一部のロケーションが一時的に使用できなくなっている場合に入力されます。

認可スコープ

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

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

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