Method: projects.databases.indexes.list

Lista os índices que correspondem aos filtros especificados.

Solicitação HTTP

GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*}/indexes

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

Parâmetros de caminho

Parâmetros
parent

string

O nome do banco de dados. Exemplo: projects/{projectId}/databases/{databaseId}

Parâmetros de consulta

Parâmetros
filter

string

pageSize

integer

O tamanho padrão de página de lista.

pageToken

string

O token padrão de página de lista.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A resposta para FirestoreAdmin.ListIndexes.

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

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

object (Index)

Os índices.

nextPageToken

string

O token de próxima página da lista padrão.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.