Method: projects.locations.instances.list

Mencantumkan setiap DatabaseInstance yang terkait dengan proyek induk tertentu.

Item daftar dikembalikan tanpa urutan tertentu, namun akan menjadi tampilan konsisten dari instance database ketika permintaan tambahan dibuat dengan pageToken .

Daftar yang dihasilkan berisi instance di STATE mana pun.

Hasil daftar mungkin akan basi dalam beberapa detik.

Gunakan instances.get untuk pembacaan yang konsisten.

permintaan HTTP

GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances

URL menggunakan sintaks Transcoding gRPC .

Parameter jalur

Parameter
parent

string

Proyek induk yang akan mencantumkan instance database, dalam bentuk: projects/{project-number}/locations/{location-id}

Untuk membuat daftar di semua lokasi, gunakan induk dalam bentuk: projects/{project-number}/locations/-

Otorisasi memerlukan izin IAM berikut pada parent sumber daya yang ditentukan:

  • firebasedatabase.instances.list

Parameter kueri

Parameter
pageToken

string

Token dikembalikan dari panggilan sebelumnya ke instances.list yang menunjukkan di mana dalam kumpulan instance database untuk melanjutkan pencatatan.

pageSize

integer

Jumlah maksimum instans database yang akan dikembalikan dalam respons.

Server dapat mengembalikan lebih sedikit dari ini sesuai kebijakannya. Jika tidak ada nilai yang ditentukan (atau nilai yang ditentukan terlalu besar), maka server akan menerapkan batasannya sendiri.

showDeleted

boolean

Tunjukkan bahwa DatabaseInstances dalam status DELETED juga harus dikembalikan.

Permintaan tubuh

Badan permintaan harus kosong.

Badan respons

Jika berhasil, isi respons berisi data dengan struktur berikut:

Respons dari metode instances.list .

Representasi JSON
{
  "instances": [
    {
      object (DatabaseInstance)
    }
  ],
  "nextPageToken": string
}
Bidang
instances[]

object ( DatabaseInstance )

Daftar setiap DatabaseInstance yang ada di proyek induk Firebase.

nextPageToken

string

Jika daftar hasil terlalu besar untuk ditampung dalam satu respons, maka token akan dikembalikan. Jika stringnya kosong, maka respons ini adalah halaman terakhir dari hasil.

Token ini dapat digunakan dalam panggilan berikutnya ke instances.list untuk menemukan grup instance database berikutnya.

Token halaman berumur pendek dan tidak boleh disimpan.

Lingkup Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

Untuk informasi lebih lanjut, lihat Ikhtisar Otentikasi .