Method: projects.availableLocations.list

Перечисляет действительные местоположения ресурсов Google Cloud Platform (GCP) для указанного проекта (включая FirebaseProject ).

Одно из этих местоположений можно выбрать в качестве местоположения ресурсов GCP проекта по умолчанию , то есть географического местоположения, в котором ресурсы проекта, такие как Cloud Firestore, будут предоставляться по умолчанию. Однако если для проекта уже установлено местоположение ресурса GCP по умолчанию, этот параметр нельзя изменить.

Этот вызов проверяет любые возможные ограничения местоположения для указанного проекта и, таким образом, может вернуть подмножество всех возможных местоположений ресурсов GCP. Чтобы получить список всех расположений ресурсов GCP (независимо от каких-либо ограничений), вызовите конечную точку, не указывая уникальный идентификатор проекта (то есть /v1beta1/{parent=projects/-}/listAvailableLocations ).

Чтобы вызвать availableLocations.list с указанным проектом, участник должен быть как минимум наблюдателем проекта. Вызовы без указания проекта не требуют каких-либо конкретных разрешений проекта.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
parent

string

FirebaseProject для которого нужно перечислить местоположения ресурсов GCP, в формате:

projects/ PROJECT_IDENTIFIER

Подробную информацию о значениях PROJECT_IDENTIFIER см. в поле name FirebaseProject .

Если уникальный идентификатор проекта не указан (то есть projects/- ), возвращаемый список не учитывает ограничения местоположения, специфичные для организации или проекта.

Параметры запроса

Параметры
pageToken

string

Токен, возвращенный из предыдущего вызова availableLocations.list , указывающий, где в списке местоположений возобновить листинг.

pageSize

integer

Максимальное количество местоположений, возвращаемых в ответе.

Сервер может вернуть меньшее значение по своему усмотрению. Если значение не указано (или указано слишком большое значение), то сервер наложит свой собственный лимит.

Это значение не может быть отрицательным.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Поля
locations[]

object ( Location )

Одна страница результатов вызова availableLocations.list .

nextPageToken

string

Если список результатов слишком велик, чтобы поместиться в один ответ, возвращается токен. Если строка пуста, то этот ответ является последней страницей результатов и перечислены все доступные местоположения.

Этот токен можно использовать при последующем вызове availableLocations.list для поиска дополнительных местоположений.

Токены страниц недолговечны и не должны сохраняться.

Области авторизации

Требуется одна из следующих областей 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

Для получения дополнительной информации см. Обзор аутентификации .

Расположение

Местоположение ресурса GCP, которое можно выбрать для FirebaseProject .

JSON-представление 
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
Поля
locationId

string

Идентификатор местоположения ресурса GCP. Это будет одно из доступных мест ресурсов GCP .

type

enum ( LocationType )

Указывает, является ли расположение ресурса GCP региональным или многорегиональным расположением для репликации данных.

features[]

enum ( LocationFeature )

Продукты и услуги, доступные в расположении ресурса GCP.

Тип местоположения

Указывает, как данные реплицируются в местоположении ресурса GCP. Узнайте больше о типах местоположений ресурсов GCP .

Перечисления
LOCATION_TYPE_UNSPECIFIED Используется внутри для различения неустановленных значений и не предназначен для внешнего использования.
REGIONAL

Местоположение является региональным.

Данные в региональном расположении реплицируются в несколько зон внутри региона.

MULTI_REGIONAL

Местоположение является мультирегиональным.

Данные в расположении с несколькими регионами реплицируются в несколько регионов. Внутри каждого региона данные реплицируются в несколько зон.

МестоположениеОсобенность

Продукты и услуги, доступные в расположении ресурса GCP.

Перечисления
LOCATION_FEATURE_UNSPECIFIED Используется внутри для различения неустановленных значений и не предназначен для внешнего использования.
FIRESTORE

Это расположение поддерживает экземпляры базы данных Cloud Firestore.

В этом расположении доступен App Engine, поэтому оно может быть расположением ресурсов GCP проекта по умолчанию .

DEFAULT_STORAGE

Это расположение поддерживает сегменты Cloud Storage по умолчанию.

В этом расположении доступен App Engine, поэтому оно может быть расположением ресурсов GCP проекта по умолчанию .

FUNCTIONS Облачные функции для Firebase доступны по этому адресу.