Method: projects.availableLocations.list

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

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

Panggilan ini memeriksa kemungkinan pembatasan lokasi untuk Project yang ditentukan dan, oleh karena itu, dapat menampilkan subset dari semua kemungkinan lokasi resource GCP. Untuk menampilkan daftar 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 project yang ditentukan, setidaknya anggota harus menjadi Viewer Project. Panggilan tanpa project yang ditentukan tidak memerlukan izin project tertentu.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

FirebaseProject yang akan digunakan untuk mencantumkan lokasi resource GCP, dalam format:

projects/PROJECT_IDENTIFIER

Lihat kolom FirebaseProject name untuk mengetahui detail tentang nilai PROJECT_IDENTIFIER.

Jika ID project unik tidak ditentukan (yaitu projects/-), daftar yang ditampilkan tidak memperhitungkan batasan lokasi spesifik per organisasi atau spesifik per project.

Parameter kueri

Parameter
pageToken

string

Token yang ditampilkan dari panggilan sebelumnya ke availableLocations.list yang menunjukkan posisi dalam daftar lokasi untuk melanjutkan listingan.
pageSize

integer

Jumlah maksimum lokasi yang akan ditampilkan dalam respons.

Server dapat menampilkan lebih sedikit dari ini atas pertimbangannya sendiri. Jika tidak ada nilai yang ditentukan (atau nilai yang ditentukan terlalu besar), server akan menerapkan batasnya sendiri.

Nilai ini tidak boleh negatif.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

object (Location)

Satu halaman hasil dari panggilan ke availableLocations.list.
nextPageToken

string

Jika daftar hasil terlalu besar untuk dimasukkan dalam satu respons, token akan ditampilkan. Jika string kosong, berarti 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 dipertahankan.

Cakupan 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 mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

Lokasi

Lokasi resource GCP yang dapat dipilih untuk FirebaseProject.

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

string

ID lokasi resource GCP. Resource ini akan menjadi salah satu lokasi resource GCP yang tersedia.
type

enum (LocationType)

Menunjukkan apakah lokasi resource GCP adalah lokasi regional atau multi-regional untuk replikasi data.
features[]

enum (LocationFeature)

Produk dan layanan yang tersedia di lokasi resource GCP.

Jenis Lokasi

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

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

Lokasi adalah lokasi regional.

Data di lokasi regional direplikasi di beberapa zona dalam satu region.
MULTI_REGIONAL

Lokasinya adalah lokasi multi-regional.

Data di lokasi multi-region direplikasi di beberapa region. Dalam setiap region, data direplikasi di beberapa zona.

LocationFeature

Produk dan layanan yang tersedia di lokasi resource GCP.

Enum
LOCATION_FEATURE_UNSPECIFIED Digunakan secara internal untuk membedakan 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 berupa lokasi resource GCP default Project.
DEFAULT_STORAGE

Lokasi ini mendukung bucket Cloud Storage default.

App Engine tersedia di lokasi ini, sehingga dapat berupa lokasi resource GCP default Project.
FUNCTIONS Cloud Functions for Firebase tersedia di lokasi ini.