Method: projects.locations.instances.list

Lista cada DatabaseInstance associado ao projeto pai especificado.

Os itens da lista são retornados em nenhuma ordem específica, mas serão uma visualizaçã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 desatualizados por alguns segundos.

Use instances.get para leituras consistentes.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

O projeto pai para que as instâncias de banco de dados serão listadas, no formato: projects/{project-number}/locations/{location-id}

Para listar em todos os locais, use um pai no formulário: projects/{project-number}/locations/-

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • firebasedatabase.instances.list

Parâmetros de consulta

Parâmetros
pageToken

string

Token retornado de uma chamada anterior para instances.list que indica de onde no conjunto de instâncias de banco de dados retomar a listagem.
pageSize

integer

O número máximo de instâncias de banco de dados a serem retornadas na resposta.

O servidor pode retornar menos que isso a seu critério. Se nenhum valor for especificado (ou um valor muito grande for especificado), o servidor impõe um limite próprio.
showDeleted

boolean

Indica que DatabaseInstances no estado DELETED também precisam ser retornados.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

A resposta do método instances.list.

Representação JSON 
{
  "instances": [
    {
      object (DatabaseInstance)
    }
  ],
  "nextPageToken": string
}
Campos
instances[]

object (DatabaseInstance)

Lista de cada DatabaseInstance que está no projeto pai do Firebase.
nextPageToken

string

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 é a última página de resultados.

Esse token pode ser usado em uma chamada subsequente para instances.list para encontrar o próximo grupo de instâncias do banco de dados.

Os tokens de página são de curta duração e não devem ser persistidos.

Escopos de autorização

Requer um dos seguintes escopos do 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 saber mais, consulte a Visão geral da autenticação.