Lista os locais de recursos válidos do Google Cloud Platform (GCP) para o projeto especificado (incluindo um FirebaseProject
).
Um desses locais pode ser selecionado como o local padrão do recurso 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 padrão do recurso GCP já tiver sido definido para o projeto, essa configuração não poderá ser alterada.
Essa chamada verifica possíveis restrições de local para o projeto especificado e, portanto, pode retornar um subconjunto de todos os locais de recursos possíveis 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. As 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 a sintaxe de transcodificação gRPC .
Parâmetros de caminho
Parâmetros | |
---|---|
parent | O Consulte o campo Se nenhum identificador de projeto exclusivo for especificado (ou seja, |
Parâmetros de consulta
Parâmetros | |
---|---|
pageToken | Token retornado de uma chamada anterior para |
pageSize | 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. |
Corpo da solicitação
O corpo da solicitação deve estar vazio.
corpo da resposta
Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:
representação JSON |
---|
{
"locations": [
{
object ( |
Campos | |
---|---|
locations[] | Uma página de resultados de uma chamada para |
nextPageToken | 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 é a última página de resultados e todos os locais disponíveis foram listados. Esse token pode ser usado em uma chamada subsequente para Os tokens de página têm vida curta e não devem ser mantidos. |
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 ( |
Campos | |
---|---|
locationId | O ID do local do recurso do GCP. Será um dos locais de recursos GCP disponíveis. |
type | Indica se o local do recurso GCP é um local regional ou multirregional para replicação de dados. |
features[] | 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 GCP. Saiba mais sobre os tipos de localização de recursos do GCP .
Enums | |
---|---|
LOCATION_TYPE_UNSPECIFIED | Usado internamente para distinguir valores não definidos e não se destina a uso externo. |
REGIONAL | A localização é uma localização regional. Os dados em um local regional são replicados em várias zonas dentro de uma região. |
MULTI_REGIONAL | O local é um local multirregional. Os dados em um local multirregional são replicados em várias regiões. Dentro de cada região, os dados são replicados em várias 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 a 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, portanto, pode ser o local de recurso GCP padrão de um projeto . |
DEFAULT_STORAGE | Este local oferece suporte a intervalos padrão do Cloud Storage. O App Engine está disponível neste local, portanto, pode ser o local de recurso GCP padrão de um projeto . |
FUNCTIONS | O Cloud Functions para Firebase está disponível neste local. |