Method: projects.locations.bareMetalClusters.list

指定されたプロジェクトとロケーションのベアメタル クラスタを一覧表示します。

HTTP リクエスト

GET https://gkeonprem.googleapis.com/v1/{parent=projects/*/locations/*}/bareMetalClusters

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

パスパラメータ

パラメータ
parent

string

必須。クラスタが一覧表示されるプロジェクトとロケーションの親。形式: projects/{project}/locations/{location}

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定されていない場合、最大で 50 個のクラスタが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。
pageToken

string

サーバーが返す必要がある結果のページを特定するトークン。
filter

string

https://google.aip.dev/160 に従うリソース フィルタリング式。空でない場合、属性フィールドがフィルタに一致するリソースのみが返されます。
view

enum (ClusterView)

ベアメタル クラスタのビュー。BASIC が指定されている場合、クラスタ リソース名と管理クラスタ メンバーシップのみが返されます。デフォルト値または未設定の値 CLUSTER_VIEW_UNSPECIFIED は FULL と同じで、クラスタ構成の詳細をすべて返します。
allowMissing

boolean

省略可。true の場合、BareMetal クラスタのリストを返します。RMS にのみ存在する BareMetal クラスタも返されます。

リクエストの本文

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

レスポンスの本文

ベアメタル クラスタを一覧表示するためのレスポンス メッセージ。

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

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

object (BareMetalCluster)

ベアメタル クラスタのリスト。
nextPageToken

string

サーバーが返す必要がある結果のページを特定するトークン。トークンが空でない場合、さらに結果が存在するため、指定されたページトークンを使用してリクエストを繰り返して取得する必要があります。
unreachable[]

string

到達できなかった場所。

認可スコープ

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

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

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

ClusterView

クラスタ リソースのビュー。

列挙型
CLUSTER_VIEW_UNSPECIFIED 値が設定されていない場合、デフォルトの FULL ビューが使用されます。
BASIC クラスタ リソースの名前や管理クラスタ メンバーシップなど、クラスタ リソースの基本情報が含まれます。
FULL ベアメタル クラスタ リソースの完全な構成が含まれます。これは、ListBareMetalClustersRequest メソッドのデフォルト値です。