Method: projects.availableLocations.list

Mencantumkan lokasi resource Google Cloud Platform (GCP) yang valid untuk Proyek yang ditentukan (termasuk FirebaseProject ).

Salah satu lokasi ini dapat dipilih sebagai lokasi sumber daya GCP default Proyek, yang merupakan lokasi geografis tempat sumber daya Proyek, seperti Cloud Firestore, akan disediakan secara default. Namun, jika lokasi sumber daya GCP default telah ditetapkan untuk Proyek, maka setelan ini tidak dapat diubah.

Panggilan ini memeriksa kemungkinan pembatasan lokasi untuk Proyek tertentu dan, dengan demikian, mungkin menampilkan subkumpulan semua kemungkinan lokasi resource GCP. Untuk mencantumkan semua lokasi resource GCP (terlepas dari batasan apa pun), panggil endpoint tanpa menentukan ID project unik (yaitu, /v1beta1/{parent=projects/-}/listAvailableLocations ).

Untuk memanggil availableLocations.list dengan proyek tertentu, anggota minimal harus menjadi Viewer Proyek. Panggilan tanpa proyek tertentu tidak memerlukan izin proyek tertentu.

permintaan HTTP

GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}/availableLocations

URL menggunakan sintaks Transcoding gRPC .

Parameter jalur

Parameter
parent

string

FirebaseProject yang akan mencantumkan lokasi resource GCP, dalam format:

projects/ PROJECT_IDENTIFIER

Lihat kolom FirebaseProject name untuk mengetahui detail tentang nilai PROJECT_IDENTIFIER .

Jika tidak ada pengidentifikasi proyek unik yang ditentukan (yaitu, projects/- ), daftar yang dikembalikan tidak memperhitungkan batasan lokasi spesifik organisasi atau spesifik proyek.

Parameter kueri

Parameter
pageToken

string

Token dikembalikan dari panggilan sebelumnya ke availableLocations.list yang menunjukkan di mana dalam daftar lokasi untuk melanjutkan pencatatan.

pageSize

integer

Jumlah maksimum lokasi yang akan dikembalikan dalam respons.

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

Nilai ini tidak boleh negatif.

Permintaan tubuh

Badan permintaan harus kosong.

Badan respons

Jika berhasil, isi respons berisi data dengan struktur berikut:

Representasi JSON
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
bidang
locations[]

object ( Location )

Satu halaman hasil dari panggilan ke availableLocations.list .

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 hasil dan semua lokasi yang tersedia telah dicantumkan.

Token ini dapat digunakan dalam panggilan berikutnya ke availableLocations.list untuk menemukan lebih banyak lokasi.

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 .

Lokasi

Lokasi resource GCP yang dapat dipilih untuk FirebaseProject .

Representasi JSON
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
bidang
locationId

string

ID lokasi resource GCP. Ini akan menjadi salah satu lokasi resource GCP yang tersedia.

type

enum ( LocationType )

Menunjukkan apakah lokasi resource GCP merupakan lokasi regional atau multi-regional untuk replikasi data.

features[]

enum ( LocationFeature )

Produk dan layanan yang tersedia di lokasi resource GCP.

Tipe Lokasi

Menentukan cara data direplikasi dalam lokasi resource GCP. Pelajari lebih lanjut jenis lokasi resource GCP .

Enum
LOCATION_TYPE_UNSPECIFIED Digunakan secara internal untuk membedakan nilai-nilai yang tidak ditetapkan dan tidak dimaksudkan untuk penggunaan eksternal.
REGIONAL

Lokasinya merupakan lokasi regional.

Data di lokasi regional direplikasi di beberapa zona dalam suatu wilayah.

MULTI_REGIONAL

Lokasinya merupakan lokasi multi-regional.

Data di lokasi multi-wilayah direplikasi di beberapa wilayah. Di setiap wilayah, data direplikasi di beberapa zona.

Fitur Lokasi

Produk dan layanan yang tersedia di lokasi resource GCP.

Enum
LOCATION_FEATURE_UNSPECIFIED Digunakan secara internal untuk membedakan nilai-nilai yang tidak ditetapkan dan tidak dimaksudkan untuk penggunaan eksternal.
FIRESTORE

Lokasi ini mendukung instance database Cloud Firestore.

App Engine tersedia di lokasi ini, sehingga dapat menjadi lokasi sumber daya GCP default Proyek.

DEFAULT_STORAGE

Lokasi ini mendukung bucket Cloud Storage default.

App Engine tersedia di lokasi ini, sehingga dapat menjadi lokasi sumber daya GCP default Proyek.

FUNCTIONS Cloud Functions for Firebase tersedia di lokasi ini.