Method: projects.databases.collectionGroups.indexes.list

Listet zusammengesetzte Indexe auf.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Ein übergeordneter Name im Format projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Abfrageparameter

Parameter
filter

string

Der Filter, der auf die Listenergebnisse angewendet werden soll.
pageSize

integer

Die Anzahl der zurückzugebenden Ergebnisse.
pageToken

string

Ein Seitentoken, das von einem vorherigen Aufruf an FirestoreAdmin.ListIndexes zurückgegeben wurde und zum Abrufen der nächsten Ergebnisseite verwendet werden kann.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwort für FirestoreAdmin.ListIndexes.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "nextPageToken": string
}
Felder
indexes[]

object (Index)

Die angeforderten Indexe.
nextPageToken

string

Ein Seitentoken, mit dem eine weitere Ergebnisseite angefordert werden kann. Wenn das Feld leer ist, ist dies die letzte Seite.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.