Lista cada DatabaseInstance
associado ao projeto pai especificado.
Os itens da lista são retornados em nenhuma ordem específica, mas serão uma exibição consistente das instâncias do banco de dados quando solicitações adicionais forem feitas com um pageToken
.
A lista resultante contém instâncias em qualquer STATE
.
Os resultados da lista podem ficar obsoletos por alguns segundos.
Use instances.get
para leituras consistentes.
solicitação HTTP
GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances
A URL usa a sintaxe de transcodificação gRPC .
Parâmetros de caminho
Parâmetros | |
---|---|
parent | O projeto pai para o qual listar instâncias de banco de dados, no formato: Para listar todos os locais, use um pai no formulário: A autorização requer a seguinte permissão do IAM no
|
Parâmetros de consulta
Parâmetros | |
---|---|
pageToken | Token retornado de uma chamada anterior para |
pageSize | O número máximo de instâncias de banco de dados a serem retornadas na resposta. O servidor pode retornar menos do que isso a seu critério. Se nenhum valor for especificado (ou um valor muito grande for especificado), o servidor imporá seu próprio limite. |
showDeleted | Indique que DatabaseInstances no estado |
Corpo da solicitação
O corpo da solicitação deve estar vazio.
Corpo de resposta
Se for bem-sucedido, o corpo da resposta conterá dados com a seguinte estrutura:
A resposta do método instances.list
.
Representação JSON |
---|
{
"instances": [
{
object ( |
Campos | |
---|---|
instances[] | Lista de cada |
nextPageToken | Se a lista de resultados for muito grande para caber em uma única resposta, um token será retornado. Se a string estiver vazia, essa resposta será a última página de resultados. Esse token pode ser usado em uma chamada subsequente para Os tokens de página têm vida curta e não devem ser persistidos. |
Escopos de autorização
Requer um dos seguintes escopos 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
Para obter mais informações, consulte a Visão geral da autenticação .