Method: projects.availableLocations.list

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

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

Esta llamada verifica posibles restricciones de ubicación para el proyecto especificado y, por lo tanto, podría devolver un subconjunto de todas las posibles ubicaciones de recursos de GCP. Para enumerar todas las ubicaciones de recursos de GCP (independientemente de las restricciones), llame al punto final sin especificar un identificador de proyecto único (es decir, /v1beta1/{parent=projects/-}/listAvailableLocations ).

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

solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
parent

string

El FirebaseProject para el cual enumerar las ubicaciones de recursos de GCP, en el formato:

projects/ PROJECT_IDENTIFIER

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

Si no se especifica ningún identificador de proyecto único (es decir, projects/- ), la lista devuelta 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

Token devuelto de una llamada anterior a availableLocations.list que indica en qué parte de la lista de ubicaciones se debe reanudar la lista.

pageSize

integer

El número máximo de ubicaciones que se devolverán en la respuesta.

El servidor puede devolver menos de este valor a su 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 respuesta

Si tiene éxito, 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 de una llamada a availableLocations.list .

nextPageToken

string

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

Este token se puede utilizar en una llamada posterior a availableLocations.list para buscar más ubicaciones.

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

Alcances de autorización

Requiere uno de los siguientes ámbitos 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, consulte Descripción general de la autenticación .

Ubicación

Una ubicación de recursos de GCP que se puede seleccionar para un 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 del recurso 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.

Tipo de ubicacion

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

Enumeraciones
LOCATION_TYPE_UNSPECIFIED Se utiliza internamente para distinguir valores no establecidos y no está diseñado para uso externo.
REGIONAL

La ubicación es una ubicación regional.

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

MULTI_REGIONAL

La ubicación es una ubicación multirregional.

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

UbicaciónCaracterística

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

Enumeraciones
LOCATION_FEATURE_UNSPECIFIED Se utiliza internamente para distinguir valores no establecidos y 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 de recursos de GCP predeterminada de un proyecto.

DEFAULT_STORAGE

Esta ubicación admite depósitos predeterminados de Cloud Storage.

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

FUNCTIONS Cloud Functions para Firebase está disponible en esta ubicación.