Method: projects.availableLocations.list

Lista os locais de recursos válidos do Google Cloud Platform (GCP) para o projeto especificado (incluindo FirebaseProject ).

Um desses locais pode ser selecionado como o local padrão de recursos do GCP do projeto, que é o local geográfico onde os recursos do projeto, como o Cloud Firestore, serão provisionados por padrão. No entanto, se o local de recurso padrão do GCP já tiver sido definido para o projeto, essa configuração não poderá ser alterada.

Essa chamada verifica possíveis restrições de localização para o projeto especificado e, portanto, pode retornar um subconjunto de todos os locais possíveis de recursos do GCP. Para listar todos os locais de recursos do GCP (independentemente de quaisquer restrições), chame o endpoint sem especificar um identificador de projeto exclusivo (ou seja, /v1beta1/{parent=projects/-}/listAvailableLocations ).

Para chamar availableLocations.list com um projeto especificado, um membro deve ser, no mínimo, um Visualizador do Projeto. Chamadas sem um projeto especificado não requerem nenhuma permissão de projeto específica.

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
parent

string

O FirebaseProject para o qual listar locais de recursos do GCP, no formato:

projects/ PROJECT_IDENTIFIER

Consulte o campo name FirebaseProject para obter detalhes sobre os valores PROJECT_IDENTIFIER .

Se nenhum identificador de projeto exclusivo for especificado (ou seja, projects/- ), a lista retornada não levará em consideração restrições de localização específicas da organização ou do projeto.

Parâmetros de consulta

Parâmetros
pageToken

string

Token retornado de uma chamada anterior para availableLocations.list indicando onde na lista de locais retomar a listagem.

pageSize

integer

O número máximo de locais a serem retornados na resposta.

O servidor pode retornar menos que esse valor a seu critério. Se nenhum valor for especificado (ou um valor muito grande for especificado), o servidor imporá seu próprio limite.

Este valor não pode ser negativo.

Solicitar corpo

O corpo da solicitação deve estar vazio.

Corpo de resposta

Se for bem-sucedido, o corpo da resposta conterá dados com a seguinte estrutura:

Representação JSON
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Campos
locations[]

object ( Location )

Uma página de resultados de uma chamada para availableLocations.list .

nextPageToken

string

Se a lista de resultados for muito grande para caber em uma única resposta, um token será retornado. Se a string estiver vazia, esta resposta será a última página de resultados e todos os locais disponíveis foram listados.

Esse token pode ser usado em uma chamada subsequente para availableLocations.list para encontrar mais locais.

Os tokens de página têm vida curta e não devem ser persistidos.

Escopos de autorização

Requer um dos seguintes escopos 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

Para obter mais informações, consulte Visão geral da autenticação .

Localização

Um local de recurso do GCP que pode ser selecionado para um FirebaseProject .

Representação JSON
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
Campos
locationId

string

O ID do local do recurso do GCP. Será um dos locais de recursos disponíveis do GCP .

type

enum ( LocationType )

Indica se o local do recurso do GCP é regional ou multirregional para replicação de dados.

features[]

enum ( LocationFeature )

Produtos e serviços disponíveis no local de recursos do GCP.

Tipo de localização

Especifica como os dados são replicados no local do recurso do GCP. Saiba mais sobre os tipos de locais de recursos do GCP .

Enums
LOCATION_TYPE_UNSPECIFIED Usado internamente para distinguir valores não definidos e não se destina ao uso externo.
REGIONAL

O local é regional.

Os dados em um local regional são replicados em diversas zonas de uma região.

MULTI_REGIONAL

O local é multirregional.

Os dados em um local multirregional são replicados em diversas regiões. Dentro de cada região, os dados são replicados em diversas zonas.

Recurso de localização

Produtos e serviços disponíveis no local de recursos do GCP.

Enums
LOCATION_FEATURE_UNSPECIFIED Usado internamente para distinguir valores não definidos e não se destina ao uso externo.
FIRESTORE

Este local oferece suporte a instâncias de banco de dados do Cloud Firestore.

O App Engine está disponível neste local, por isso pode ser o local de recurso padrão do GCP de um projeto.

DEFAULT_STORAGE

Este local é compatível com buckets padrão do Cloud Storage.

O App Engine está disponível neste local, por isso pode ser o local de recurso padrão do GCP de um projeto.

FUNCTIONS O Cloud Functions para Firebase está disponível neste local.