Method: projects.locations.instances.list

Répertorie chaque DatabaseInstance associée au projet parent spécifié.

Les éléments de la liste sont renvoyés sans ordre particulier, mais constitueront une vue cohérente des instances de base de données lorsque des demandes supplémentaires seront effectuées avec un pageToken .

La liste résultante contient des instances dans n'importe quel STATE .

Les résultats de la liste peuvent être obsolètes de quelques secondes.

Utilisez instances.get pour des lectures cohérentes.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC .

Paramètres du chemin

Paramètres
parent

string

Le projet parent pour lequel répertorier les instances de base de données, sous la forme : projects/{project-number}/locations/{location-id}

Pour répertorier tous les emplacements, utilisez un parent sous la forme : projects/{project-number}/locations/-

L'autorisation nécessite l'autorisation IAM suivante sur la ressource parent spécifiée :

  • firebasedatabase.instances.list

Paramètres de requête

Paramètres
pageToken

string

Jeton renvoyé lors d'un appel précédent à instances.list indiquant où dans l'ensemble des instances de base de données reprendre la liste.

pageSize

integer

Nombre maximum d'instances de base de données à renvoyer dans la réponse.

Le serveur peut en renvoyer moins à sa discrétion. Si aucune valeur n'est spécifiée (ou si une valeur trop grande est spécifiée), alors le serveur imposera sa propre limite.

showDeleted

boolean

Indiquez que les DatabaseInstances à l’état DELETED doivent également être renvoyées.

Corps de la demande

Le corps de la requête doit être vide.

Corps de réponse

En cas de succès, le corps de la réponse contient des données avec la structure suivante :

La réponse de la méthode instances.list .

Représentation JSON
{
  "instances": [
    {
      object (DatabaseInstance)
    }
  ],
  "nextPageToken": string
}
Des champs
instances[]

object ( DatabaseInstance )

Liste de chaque DatabaseInstance qui se trouve dans le projet Firebase parent.

nextPageToken

string

Si la liste de résultats est trop longue pour tenir dans une seule réponse, un jeton est renvoyé. Si la chaîne est vide, alors cette réponse constitue la dernière page de résultats.

Ce jeton peut être utilisé lors d'un appel ultérieur à instances.list pour rechercher le groupe suivant d'instances de base de données.

Les jetons de page sont de courte durée et ne doivent pas être conservés.

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

  • 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

Pour plus d'informations, consultez la Présentation de l'authentification .