Перечисляет каждый DatabaseInstance
, связанный с указанным родительским проектом.
Элементы списка возвращаются в произвольном порядке, но будут представлять собой согласованное представление экземпляров базы данных при выполнении дополнительных запросов с помощью pageToken
.
Результирующий список содержит экземпляры в любом состоянии STATE
.
Результаты списка могут быть устаревшими на несколько секунд.
Используйте instances.get
для согласованного чтения.
HTTP-запрос
GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
parent | Родительский проект, для которого нужно перечислить экземпляры базы данных, в форме: Чтобы просмотреть все местоположения, используйте родительский элемент в форме: Для авторизации требуется следующее разрешение IAM для указанного
|
Параметры запроса
Параметры | |
---|---|
pageToken | Токен, возвращенный из предыдущего вызова |
pageSize | Максимальное количество экземпляров базы данных, возвращаемых в ответе. Сервер может вернуть меньшее количество по своему усмотрению. Если значение не указано (или указано слишком большое значение), то сервер наложит свой собственный лимит. |
showDeleted | Укажите, что экземпляры DatabaseInstances в состоянии |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит данные следующей структуры:
Ответ метода instances.list
.
JSON-представление |
---|
{
"instances": [
{
object ( |
Поля | |
---|---|
instances[] | Список каждого |
nextPageToken | Если список результатов слишком велик, чтобы поместиться в один ответ, возвращается токен. Если строка пуста, то этот ответ является последней страницей результатов. Этот токен можно использовать при последующем вызове Токены страниц недолговечны и не должны сохраняться. |
Области авторизации
Требуется одна из следующих областей 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
Для получения дополнительной информации см. Обзор аутентификации .