Listenindexer (Azure AI Search-REST-API)

  • Artikel

Der Vorgang List Indexers gibt die Liste der Indexer in Ihrer Azure AI-Suchdienst zurück.

GET https://[service name].search.windows.net/indexers?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]

URI-Parameter

Parameter BESCHREIBUNG
Dienstname Erforderlich. Legen Sie dies auf den eindeutigen, benutzerdefinierten Namen Ihres Suchdiensts fest.
api-version Erforderlich. Die aktuelle stabile Version ist api-version=2020-06-30. Weitere Versionen finden Sie unter API-Versionen .

Anforderungsheader

Die folgende Tabelle beschreibt die erforderlichen und optionalen Anforderungsheader.

Felder BESCHREIBUNG
Content-Type Erforderlich. Auf application/json
api-key Optional, wenn Sie Azure-Rollen verwenden und ein Bearertoken für die Anforderung bereitgestellt wird, andernfalls ist ein Schlüssel erforderlich. Ein API-Schlüssel ist eine eindeutige, vom System generierte Zeichenfolge, die die Anforderung bei Ihrem Suchdienst authentifiziert. Abrufen von Anforderungen für eine Objektdefinition muss ein API-Schlüsselfeld enthalten, das auf Ihren Administratorschlüssel festgelegt ist (im Gegensatz zu einem Abfrageschlüssel). Weitere Informationen finden Sie unter Herstellen einer Verbindung mit Azure AI Search mithilfe der Schlüsselauthentifizierung .

Anforderungstext

Keine.

Antwort

Bei erfolgreicher Anforderung: "200 OK". Hier ist ein Beispiel-Antworttext:

{  
      "value" : [  
      {  
        "name" : "myindexer",  
        "description" : "a cool indexer",  
        "dataSourceName" : "ordersds",  
        "targetIndexName" : "orders",  
        ... other indexer properties  
      }]  
    }

Sie können die Antwort nur auf die Eigenschaften filtern, die Sie interessieren. Wenn Sie beispielsweise nur eine Liste mit Indexernamen wünschen, verwenden Sie die Abfrageoption OData $select :

GET /indexers?api-version=2020-06-30&$select=name

In diesem Fall würde die Antwort aus dem obigen Beispiel wie folgt aussehen:

{  
      "value" : [ { "name": "myindexer" } ]  
    }

Dies ist ein nützliches Verfahren, um Bandbreite zu sparen, wenn Sie über zahlreiche Indexer im Search-Dienst verfügen.

Hinweis

Wenn ein Indexer über einen Verschlüsselungsschlüssel verfügt, muss der Suchdienst Zugriff auf den Verschlüsselungsschlüssel haben, um verschlüsselte Eigenschaften in der Definition dieses Indexers abzurufen. Ohne Zugriff auf den Verschlüsselungsschlüssel wird anstelle der verschlüsselten Eigenschaften ein "<encrypted>" Platzhalter zurückgegeben. Durch die Wiederherstellung des Zugriffs auf den Schlüssel kann der Suchdienst die vollständige Indexerdefinition erneut abrufen.

Weitere Informationen