Wyświetla listę poszczególnych DatabaseInstance
skojarzonych z określonym projektem nadrzędnym.
Elementy listy są zwracane w dowolnej kolejności, ale będą stanowić spójny widok instancji bazy danych, gdy zostaną wykonane dodatkowe żądania za pomocą pageToken
.
Wynikowa lista zawiera instancje w dowolnym STATE
.
Wyniki listy mogą być nieaktualne o kilka sekund.
Użyj instances.get
, aby uzyskać spójne odczyty.
Żądanie HTTP
GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances
Adres URL używa składni transkodowania gRPC .
Parametry ścieżki
Parametry | |
---|---|
parent | Projekt nadrzędny, dla którego ma zostać wyświetlona lista instancji bazy danych, w postaci: Aby wyświetlić listę we wszystkich lokalizacjach, użyj elementu nadrzędnego w postaci: Autoryzacja wymaga następujących uprawnień dla określonego zasobu
|
Parametry zapytania
Parametry | |
---|---|
pageToken | Token zwrócony z poprzedniego wywołania |
pageSize | Maksymalna liczba instancji bazy danych zwracanych w odpowiedzi. Serwer może według własnego uznania zwrócić mniejszą kwotę. Jeśli nie zostanie określona żadna wartość (lub zostanie określona wartość zbyt duża), serwer narzuci własny limit. |
showDeleted | Wskaż, że powinny zostać zwrócone również DatabaseInstances w stanie |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Jeśli się powiedzie, treść odpowiedzi zawiera dane o następującej strukturze:
Odpowiedź z metody instances.list
.
Reprezentacja JSON |
---|
{
"instances": [
{
object ( |
Pola | |
---|---|
instances[] | Lista każdej |
nextPageToken | Jeśli lista wyników jest zbyt duża, aby zmieścić się w jednej odpowiedzi, zwracany jest token. Jeśli ciąg jest pusty, ta odpowiedź jest ostatnią stroną wyników. Token ten można wykorzystać w kolejnym wywołaniu Tokeny strony są krótkotrwałe i nie należy ich utrwalać. |
Zakresy autoryzacji
Wymaga jednego z następujących zakresów 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
Aby uzyskać więcej informacji, zobacz Omówienie uwierzytelniania .