Method: projects.availableLocations.list

Elenca le posizioni valide delle risorse Google Cloud Platform (GCP) per il progetto specificato (incluso FirebaseProject ).

Una di queste posizioni può essere selezionata come posizione predefinita delle risorse GCP del progetto, ovvero la posizione geografica in cui verrà eseguito il provisioning delle risorse del progetto, come Cloud Firestore, per impostazione predefinita. Tuttavia, se la posizione predefinita delle risorse GCP è già stata impostata per il progetto, questa impostazione non può essere modificata.

Questa chiamata verifica eventuali restrizioni sulla posizione per il progetto specificato e, pertanto, potrebbe restituire un sottoinsieme di tutte le possibili posizioni delle risorse GCP. Per elencare tutte le posizioni delle risorse GCP (indipendentemente da eventuali restrizioni), chiama l'endpoint senza specificare un identificatore di progetto univoco (ovvero /v1beta1/{parent=projects/-}/listAvailableLocations ).

Per chiamare availableLocations.list con un progetto specifico, un membro deve essere almeno un visualizzatore del progetto. Le chiamate senza un progetto specifico non richiedono autorizzazioni di progetto specifiche.

Richiesta HTTP

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

L'URL usa la sintassi di transcodifica gRPC .

Parametri del percorso

Parametri
parent

string

Il FirebaseProject per il quale elencare le posizioni delle risorse GCP, nel formato:

projects/ PROJECT_IDENTIFIER

Fare riferimento al campo name FirebaseProject per dettagli sui valori PROJECT_IDENTIFIER .

Se non viene specificato alcun identificatore di progetto univoco (ovvero, projects/- ), l'elenco restituito non prende in considerazione le restrizioni sulla posizione specifiche dell'organizzazione o del progetto.

Parametri di query

Parametri
pageToken

string

Token restituito da una chiamata precedente a availableLocations.list che indica la posizione nell'elenco delle posizioni in cui riprendere l'elenco.

pageSize

integer

Il numero massimo di posizioni da restituire nella risposta.

Il server può restituire un valore inferiore a questo valore a sua discrezione. Se non viene specificato alcun valore (o viene specificato un valore troppo grande), il server imporrà il proprio limite.

Questo valore non può essere negativo.

Richiedi corpo

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Campi
locations[]

object ( Location )

Una pagina di risultati da una chiamata a availableLocations.list .

nextPageToken

string

Se l'elenco dei risultati è troppo grande per essere contenuto in una singola risposta, viene restituito un token. Se la stringa è vuota, questa risposta è l'ultima pagina dei risultati e sono state elencate tutte le posizioni disponibili.

Questo token può essere utilizzato in una chiamata successiva a availableLocations.list per trovare più posizioni.

I token di pagina hanno vita breve e non devono essere persistenti.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • 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

Per ulteriori informazioni, vedere la panoramica sull'autenticazione .

Posizione

Una posizione di risorsa GCP che può essere selezionata per FirebaseProject .

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

string

L'ID della posizione della risorsa GCP. Sarà una delle posizioni delle risorse GCP disponibili.

type

enum ( LocationType )

Indica se la posizione della risorsa GCP è una posizione regionale o multiregionale per la replica dei dati.

features[]

enum ( LocationFeature )

Prodotti e servizi disponibili nella posizione della risorsa GCP.

Tipo di posizione

Specifica il modo in cui i dati vengono replicati all'interno della posizione della risorsa GCP. Ulteriori informazioni sui tipi di posizioni delle risorse GCP .

Enumerazioni
LOCATION_TYPE_UNSPECIFIED Utilizzato internamente per distinguere i valori non impostati e non è destinato all'uso esterno.
REGIONAL

La località è una località regionale.

I dati in una posizione regionale vengono replicati in più zone all'interno di una regione.

MULTI_REGIONAL

La sede è multiregionale.

I dati in una posizione con più regioni vengono replicati in più regioni. All'interno di ciascuna regione, i dati vengono replicati in più zone.

Funzione di posizione

Prodotti e servizi disponibili nella posizione della risorsa GCP.

Enumerazioni
LOCATION_FEATURE_UNSPECIFIED Utilizzato internamente per distinguere i valori non impostati e non è destinato all'uso esterno.
FIRESTORE

Questa posizione supporta le istanze del database Cloud Firestore.

App Engine è disponibile in questa posizione, quindi può essere la posizione predefinita della risorsa GCP di un progetto.

DEFAULT_STORAGE

Questa posizione supporta i bucket Cloud Storage predefiniti.

App Engine è disponibile in questa posizione, quindi può essere la posizione predefinita della risorsa GCP di un progetto.

FUNCTIONS Cloud Functions for Firebase è disponibile in questa posizione.