Method: projects.locations.instances.list

Перечисляет каждый DatabaseInstance , связанный с указанным родительским проектом.

Элементы списка возвращаются в произвольном порядке, но будут представлять собой согласованное представление экземпляров базы данных при выполнении дополнительных запросов с помощью pageToken .

Результирующий список содержит экземпляры в любом состоянии STATE .

Результаты списка могут быть устаревшими на несколько секунд.

Используйте instances.get для согласованного чтения.

HTTP-запрос

GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances

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

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

Параметры
parent

string

Родительский проект, для которого нужно перечислить экземпляры базы данных, в форме: projects/{project-number}/locations/{location-id}

Чтобы просмотреть все местоположения, используйте родительский элемент в форме: projects/{project-number}/locations/-

Для авторизации требуется следующее разрешение IAM для указанного parent ресурса:

  • firebasedatabase.instances.list

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

Параметры
pageToken

string

Токен, возвращенный из предыдущего вызова instances.list , указывающий, где в наборе экземпляров базы данных возобновляется листинг.

pageSize

integer

Максимальное количество экземпляров базы данных, возвращаемых в ответе.

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

showDeleted

boolean

Укажите, что экземпляры DatabaseInstances в состоянии DELETED также должны быть возвращены.

Тело запроса

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

Тело ответа

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

Ответ метода instances.list .

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

object ( DatabaseInstance )

Список каждого DatabaseInstance , который находится в родительском проекте Firebase.

nextPageToken

string

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

Этот токен можно использовать при последующем вызове instances.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

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