Method: projects.availableLocations.list

Enumera las ubicaciones válidas de los recursos de Google Cloud Platform (GCP) para el proyecto especificado (incluido un FirebaseProject).

Puedes seleccionar una de estas ubicaciones como la ubicación predeterminada de los recursos de GCP del proyecto, que es la ubicación geográfica en la que se aprovisionarán de forma predeterminada los recursos del proyecto, como Cloud Firestore. Sin embargo, si la ubicación predeterminada de los recursos de GCP ya se estableció para el proyecto, no se puede cambiar esta configuración.

Esta llamada verifica si hay posibles restricciones de ubicación para el proyecto especificado y, por lo tanto, puede mostrar un subconjunto de todas las ubicaciones posibles para los recursos de GCP. Para enumerar todas las ubicaciones de los recursos de GCP (independientemente de las restricciones), llama al extremo sin especificar un identificador único de proyecto (es decir, /v1beta1/{parent=projects/-}/listAvailableLocations).

Para llamar a availableLocations.list con un proyecto especificado, un miembro debe ser, como mínimo, un visualizador del proyecto. Las llamadas sin un proyecto especificado no requieren ningún permiso de proyecto específico.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

El FirebaseProject para el que se enumeran las ubicaciones de los recursos de GCP, en el formato:

projects/PROJECT_IDENTIFIER

Consulta el campo FirebaseProject name para obtener detalles sobre los valores PROJECT_IDENTIFIER.

Si no se especifica un identificador único de proyecto (es decir, projects/-), la lista que se muestra no tiene en cuenta las restricciones de ubicación específicas de la organización o del proyecto.

Parámetros de consulta

Parámetros
pageToken

string

El token que se muestra desde una llamada anterior a availableLocations.list que indica en qué lugar de la lista de ubicaciones se puede reanudar la lista.
pageSize

integer

La cantidad máxima de ubicaciones que se mostrarán en la respuesta.

Es posible que el servidor muestre menos de este valor a discreción. Si no se especifica ningún valor (o se especifica un valor demasiado grande), el servidor impondrá su propio límite.

Este valor no puede ser negativo.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Campos
locations[]

object (Location)

Una página de resultados a partir de una llamada a availableLocations.list.
nextPageToken

string

Si la lista de resultados es demasiado grande para caber en una sola respuesta, entonces se muestra un token. Si la cadena está vacía, entonces esta respuesta es la última página de resultados y se enumeran todas las ubicaciones disponibles.

Este token se puede usar en las llamadas posteriores a availableLocations.list para encontrar más ubicaciones.

Los tokens de página son de corta duración y no deben ser persistentes.

Alcances con autorización

Se necesita uno de los siguientes alcances de 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 obtener más información, consulta Descripción general de la autenticación.

Ubicación

Una ubicación de recursos de GCP que se puede seleccionar para una FirebaseProject.

Representación JSON 
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
Campos
locationId

string

El ID de la ubicación del recurso de GCP. Será una de las ubicaciones de recursos de GCP disponibles.
type

enum (LocationType)

Indica si la ubicación de los recursos de GCP es una ubicación regional o multirregional para la replicación de datos.
features[]

enum (LocationFeature)

Productos y servicios que están disponibles en la ubicación de recursos de GCP.

LocationType

Especifica cómo se replican los datos dentro de la ubicación de los recursos de GCP. Obtén más información sobre los tipos de ubicaciones de recursos de GCP.

Enums
LOCATION_TYPE_UNSPECIFIED Se usa internamente para distinguir valores no establecidos; no está diseñado para uso externo.
REGIONAL

La ubicación es regional.

Los datos de una ubicación regional se replican en varias zonas dentro de una región.
MULTI_REGIONAL

La ubicación es multirregional.

Los datos de una ubicación multirregional se replican en varias regiones. Dentro de cada región, los datos se replican en varias zonas.

LocationFeature

Productos y servicios que están disponibles en la ubicación de recursos de GCP.

Enums
LOCATION_FEATURE_UNSPECIFIED Se usa internamente para distinguir valores no establecidos; no está diseñado para uso externo.
FIRESTORE

Esta ubicación admite instancias de bases de datos de Cloud Firestore.

App Engine está disponible en esta ubicación, por lo que puede ser la ubicación predeterminada de los recursos de GCP de un proyecto.
DEFAULT_STORAGE

Esta ubicación admite buckets de Cloud Storage predeterminados.

App Engine está disponible en esta ubicación, por lo que puede ser la ubicación predeterminada de los recursos de GCP de un proyecto.
FUNCTIONS Cloud Functions para Firebase está disponible en esta ubicación.