Method: projects.locations.networkPolicies.list

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

HTTP リクエスト

GET https://vmwareengine.googleapis.com/v1/{parent=projects/*/locations/*}/networkPolicies

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

パスパラメータ

パラメータ
parent

string

必須。ネットワーク ポリシーをクエリするロケーション（リージョン）のリソース名。リソース名は、https://cloud.google.com/apis/design/resource_names の規則に従ったスキームレス URI です。例: projects/my-project/locations/us-central1

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

  • vmwareengine.networkPolicies.list

クエリ パラメータ

パラメータ
pageSize

integer

1 ページで返されるネットワーク ポリシーの最大数。サービスが返す値はこれよりも少ないことがあります。最大値は 1,000 に強制変換されます。このフィールドのデフォルト値は 500 です。
pageToken

string

前回の networkPolicies.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、networkPolicies.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
filter

string

レスポンスで返されるリソースに一致するフィルタ式。式では、フィールド名、比較演算子、フィルタリングに使用する値を指定する必要があります。値は文字列、数値、またはブール値にする必要があります。比較演算子は、=、!=、>、< のいずれかである必要があります。

たとえば、ネットワーク ポリシーのリストをフィルタリングする場合、name != "example-policy" を指定して example-policy という名前のポリシーを除外できます。

複数の式でフィルタするには、各式を個別に括弧で囲みます。次に例を示します。

(name = "example-policy")
(createTime > "2021-04-12T08:15:10.40Z")

デフォルトでは、各式は AND 式です。ただし、AND 式と OR 式は明示的に含めることができます。次に例を示します。

(name = "example-policy-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "example-policy-2")
orderBy

string

リストの結果を特定の順序で並べ替えます。デフォルトでは、返される結果は name の昇順で並べ替えられます。orderBy="name desc" を使用して、name 値に基づいて結果を降順に並べ替えることもできます。現在、name による並べ替えのみがサポートされています。

リクエストの本文

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

レスポンスの本文

VmwareEngine.ListNetworkPolicies に対するレスポンス メッセージ。

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

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

object (NetworkPolicy)

ネットワーク ポリシーのリスト。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。
unreachable[]

string

ワイルドカードを使用して集計クエリを実行したときに到達できなかったロケーション。

認可スコープ

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

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

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