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 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

string

O projeto pai para o qual listar instâncias de banco de dados, no formato: projects/{project-number}/locations/{location-id}

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

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

  • firebasedatabase.instances.list

Parâmetros de consulta

Parâmetros
pageToken

string

Token retornado de uma chamada anterior para instances.list indicando onde no conjunto de instâncias do banco de dados deve-se 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 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

boolean

Indique que DatabaseInstances no estado DELETED também deve ser retornado.

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

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

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 .