Method: projects.locations.memberships.list

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

HTTP リクエスト

GET https://gkehub.googleapis.com/v1alpha2/{parent=projects/*/locations/*}/memberships

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

パスパラメータ

パラメータ
parent

string

必須。Membership がリストされる親（プロジェクトとロケーション）。projects/*/locations/* の形式で指定します。projects/*/locations/- は、すべてのリージョンのメンバーシップを一覧表示します。

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

  • gkehub.memberships.list

クエリ パラメータ

パラメータ
pageSize

integer

省略可。リソースの「ページ」をリクエストする場合、pageSize は返されるリソースの数を指定します。指定しない場合や 0 に設定した場合は、すべてのリソースが返されます。
pageToken

string

省略可。前回の memberships.list 呼び出しによって返されたトークン。リソースの一覧表示を続行するリスト内の位置を指定します。
filter

string

省略可。https://google.aip.dev/160 で説明されている構文に従って、フィルタ式に一致するメンバーシップを一覧表示します。

例:

  • プロジェクト foo-proj とロケーション global での名前は bar です。
  name = "projects/foo-proj/locations/global/membership/bar"
  • foo というラベルを持つメンバーシップ:
  labels.foo:*
  • 値が bar の foo というラベルを持つメンバーシップ:
  labels.foo = bar
  • 状態が CREATING のメンバーシップ:
  state = CREATING
orderBy

string

省略可。比較して出力の並べ替えに使用する 1 つ以上のフィールド。https://google.aip.dev/132#ordering をご覧ください。

リクエストの本文

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

レスポンスの本文

GkeHub.ListMemberships メソッドに対するレスポンス メッセージ。

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

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

object (Membership)

一致する Membership のリスト。
nextPageToken

string

memberships.list メソッドからリソースの次のページをリクエストするトークン。空の文字列の値は、返すリソースが他にないことを示します。
unreachable[]

string

このリストの取得中に到達できなかったロケーションのリスト。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。