Method: projects.locations.clusters.list

Mencantumkan semua cluster Redis yang dimiliki oleh project di lokasi (region) tertentu atau semua lokasi.

Lokasi harus memiliki format berikut:

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

Jika locationId ditentukan sebagai - (karakter pengganti), semua region yang tersedia untuk project akan dikueri, dan hasilnya akan digabungkan.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource lokasi cluster menggunakan format: projects/{projectId}/locations/{locationId} dengan locationId mengacu pada region Google Cloud.

Parameter kueri

Parameter
pageSize

integer

Jumlah maksimum item untuk ditampilkan.

Jika tidak ditentukan, nilai default 1000 akan digunakan oleh layanan. Terlepas dari nilai pageSize, respons dapat menyertakan daftar parsial dan pemanggil hanya boleh mengandalkan nextPageToken respons untuk menentukan apakah ada lebih banyak cluster yang tersisa untuk dikueri.
pageToken

string

Nilai nextPageToken yang ditampilkan dari permintaan [clusters.list][CloudRedis.ListClusters] sebelumnya, jika ada.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons untuk [clusters.list][CloudRedis.ListClusters].

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "clusters": [
    {
      object (Cluster)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Kolom
clusters[]

object (Cluster)

Daftar cluster Redis dalam project di lokasi yang ditentukan, atau di semua lokasi.

Jika locationId di kolom induk permintaan adalah "-", semua wilayah yang tersedia untuk project akan dikueri, dan hasilnya digabungkan. Jika dalam kueri gabungan seperti itu lokasi tidak tersedia, entri Redis placeholder akan disertakan dalam respons dengan kolom name yang ditetapkan ke nilai formulir projects/{projectId}/locations/{locationId}/clusters/- dan kolom status yang ditetapkan ke ERROR serta kolom statusMessage yang ditetapkan ke "location not available for clusters.list".
nextPageToken

string

Token untuk mengambil halaman hasil berikutnya, atau kosong jika tidak ada lagi hasil dalam daftar.
unreachable[]

string

Lokasi yang tidak dapat dijangkau.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.