Method: projects.databases.collectionGroups.indexes.list

Enumera índices compuestos.

solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
parent

string

Requerido. Un nombre principal del formulario projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Parámetros de consulta

Parámetros
filter

string

El filtro que se aplicará a los resultados de la lista.

pageSize

integer

El número de resultados que se devolverán.

pageToken

string

Un token de página, devuelto por una llamada anterior a FirestoreAdmin.ListIndexes , que puede usarse para obtener la siguiente página de resultados.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de respuesta

La respuesta para FirestoreAdmin.ListIndexes .

Si tiene éxito, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "nextPageToken": string
}
Campos
indexes[]

object ( Index )

Los índices solicitados.

nextPageToken

string

Un token de página que se puede utilizar para solicitar otra página de resultados. Si está en blanco, esta es la última página.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

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

Para obtener más información, consulte Descripción general de la autenticación .