Method: projects.locations.clusters.list

指定されたロケーション（リージョン）またはすべてのロケーションにあるプロジェクトが所有するすべての Redis クラスタを一覧表示します。

場所は次の形式にする必要があります。

  • projects/{projectId}/locations/{locationId}

locationId が -（ワイルドカード）として指定されている場合、プロジェクトで使用可能なすべてのリージョンがクエリ対象となり、結果が集計されます。

HTTP リクエスト

GET https://redis.googleapis.com/v1/{parent=projects/*/locations/*}/clusters

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

パスパラメータ

パラメータ
parent

string

必須。projects/{projectId}/locations/{locationId} という形式を使用したクラスタ ロケーションのリソース名。locationId は Google Cloud リージョンを表します。

クエリ パラメータ

パラメータ
pageSize

integer

返すアイテムの最大数。

指定しない場合は、デフォルト値の 1000 が使用されます。pageSize 値に関係なく、レスポンスには部分的なリストが含まれる場合があり、クエリ対象のクラスタが他にも存在するかどうかを見極めるため、呼び出し元はレスポンスの nextPageToken のみを信頼します。
pageToken

string

前の [clusters.list][CloudRedis.ListClusters] リクエストから返された nextPageToken 値（存在する場合）。

リクエストの本文

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

レスポンスの本文

[clusters.list][CloudRedis.ListClusters] のレスポンス。

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

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

object (Cluster)

指定されたロケーション、またはすべてのロケーションにあるプロジェクト内の Redis クラスタのリスト。

リクエストの parent フィールドの locationId が「-」の場合、プロジェクトで使用可能なすべてのリージョンがクエリ対象となり、結果が集計されます。このような集計クエリでロケーションが使用できない場合、プレースホルダ Redis エントリがレスポンスに含まれます。このエントリでは、name フィールドが projects/{projectId}/locations/{locationId}/clusters/- 形式の値に設定され、status フィールドが ERROR に設定され、statusMessage フィールドが「location not available for clusters.list」に設定されます。
nextPageToken

string

結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。
unreachable[]

string

到達できなかった場所。

認可スコープ

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

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

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