Method: projects.availableLocations.list

Belirtilen Proje için ( FirebaseProject dahil) geçerli Google Cloud Platform (GCP) kaynak konumlarını listeler.

Bu konumlardan biri, Projenin varsayılan GCP kaynak konumu olarak seçilebilir; bu, Cloud Firestore gibi Proje kaynaklarının varsayılan olarak sağlanacağı coğrafi konumdur. Ancak Proje için varsayılan GCP kaynak konumu zaten ayarlanmışsa bu ayar değiştirilemez.

Bu çağrı, belirtilen Proje için olası konum kısıtlamalarını kontrol eder ve dolayısıyla tüm olası GCP kaynak konumlarının bir alt kümesini döndürebilir. Tüm GCP kaynak konumlarını listelemek için (herhangi bir kısıtlamadan bağımsız olarak), benzersiz bir proje tanımlayıcısı (yani, /v1beta1/{parent=projects/-}/listAvailableLocations ) belirtmeden uç noktayı çağırın.

availableLocations.list belirli bir projeyle çağırmak için üyenin en azından Projenin Görüntüleyicisi olması gerekir. Belirli bir projesi olmayan çağrılar herhangi bir özel proje izni gerektirmez.

HTTP isteği

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

URL, gRPC Kod Dönüştürme sözdizimini kullanır.

Yol parametreleri

Parametreler
parent

string

GCP kaynak konumlarının şu biçimde listeleneceği FirebaseProject :

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER değerleriyle ilgili ayrıntılar için FirebaseProject name alanına bakın.

Benzersiz bir proje tanımlayıcısı belirtilmezse (yani, projects/- ), döndürülen liste kuruluşa özgü veya projeye özgü konum kısıtlamalarını dikkate almaz.

Sorgu parametreleri

Parametreler
pageToken

string

Belirteç, önceki bir çağrıdan, availableLocations.list geri döndü ve konum listesinin neresinde listelemeye devam edileceğini belirtti.

pageSize

integer

Yanıtta döndürülecek maksimum konum sayısı.

Sunucu kendi takdirine bağlı olarak bu değerden daha azını döndürebilir. Hiçbir değer belirtilmezse (veya çok büyük bir değer belirtilirse), sunucu kendi sınırını uygulayacaktır.

Bu değer negatif olamaz.

Talep gövdesi

İstek gövdesi boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt gövdesi aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Alanlar
locations[]

object ( Location )

availableLocations.list çağrısından elde edilen sonuçların bir sayfası.

nextPageToken

string

Sonuç listesi tek bir yanıta sığmayacak kadar büyükse bir belirteç döndürülür. Dize boşsa bu yanıt, sonuçların son sayfasıdır ve mevcut tüm konumlar listelenmiştir.

Bu belirteç, daha fazla konum bulmak için availableLocations.list yapılan sonraki bir çağrıda kullanılabilir.

Sayfa belirteçleri kısa ömürlüdür ve kalıcı olmamalıdır.

Yetki Kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • 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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış bölümüne bakın.

Konum

FirebaseProject için seçilebilecek bir GCP kaynak konumu.

JSON gösterimi
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
Alanlar
locationId

string

GCP kaynak konumunun kimliği. Mevcut GCP kaynak konumlarından biri olacaktır.

type

enum ( LocationType )

Veri çoğaltma için GCP kaynak konumunun bölgesel mi yoksa çok bölgeli bir konum mu olduğunu belirtir.

features[]

enum ( LocationFeature )

GCP kaynak konumunda mevcut olan ürünler ve hizmetler.

Konum Türü

Verilerin GCP kaynak konumu içinde nasıl çoğaltılacağını belirtir. GCP kaynak konumlarının türleri hakkında daha fazla bilgi edinin.

Numaralandırmalar
LOCATION_TYPE_UNSPECIFIED Ayarlanmamış değerleri ayırt etmek için dahili olarak kullanılır ve harici kullanım için tasarlanmamıştır.
REGIONAL

Konum bölgesel bir konumdur.

Bölgesel bir konumdaki veriler, bir bölge içindeki birden çok bölgeye çoğaltılır.

MULTI_REGIONAL

Konum çok bölgeli bir konumdur.

Çok bölgeli bir konumdaki veriler birden çok bölgede çoğaltılır. Her bölgede veriler birden fazla bölgede çoğaltılır.

KonumÖzellik

GCP kaynak konumunda mevcut olan ürünler ve hizmetler.

Numaralandırmalar
LOCATION_FEATURE_UNSPECIFIED Ayarlanmamış değerleri ayırt etmek için dahili olarak kullanılır ve harici kullanım için tasarlanmamıştır.
FIRESTORE

Bu konum Cloud Firestore veritabanı örneklerini destekler.

App Engine bu konumda kullanılabilir olduğundan Projenin varsayılan GCP kaynak konumu olabilir.

DEFAULT_STORAGE

Bu konum, varsayılan Cloud Storage paketlerini destekler.

App Engine bu konumda kullanılabilir olduğundan Projenin varsayılan GCP kaynak konumu olabilir.

FUNCTIONS Firebase için Cloud Functions bu konumda mevcuttur.