取得 Azure AI 搜尋服務 REST API (索引器)

  • 發行項

取得索引器作業會從 Azure AI 搜尋服務取得索引器定義。

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

URI 參數

參數 Description
服務名稱 必要。 設定為搜尋服務的唯一用戶定義名稱。
索引器名稱 必要。 要求 URI 指定要傳回的索引器名稱。
api-version 如需支援的版本清單，請參閱 API 版本 。

要求標頭

下表說明必要及選用的要求標頭。

欄位 Description
Content-Type 必要。 設定為 application/json
api-key 如果您使用 Azure 角色 ，並在要求上提供持有人令牌，則為選擇性，否則需要密鑰。 如果您使用 API 金鑰，請指定管理員金鑰 (，而不是查詢金鑰) 傳回搜尋服務中的物件資訊。 如需詳細資訊，請參閱 使用密鑰驗證連線到 Azure AI 搜尋 服務。

要求本文

無。

回應

回應成功時會傳回狀態碼：200 OK。 回應類似於 建立索引器 (Azure AI 搜尋 REST API) 中的範例：

{  
    "name" : "myindexer",  
    "description" : "a cool indexer",  
    "dataSourceName" : "ordersds",  
    "targetIndexName" : "orders",  
    "schedule" : { "interval" : "PT1H", "startTime" : "2015-01-01T00:00:00Z" },  
    "parameters" : { "maxFailedItems" : 10, "maxFailedItemsPerBatch" : 5, "base64EncodeKeys": false },
    "encryptionKey": null
}

注意

如果索引器具有 加密密鑰，搜尋服務必須具有加密密鑰的存取權，才能擷取索引器定義。 如果沒有加密金鑰的存取權，則會傳回 400 不正確的要求。 還原索引鍵的存取權可讓搜尋服務再次擷取索引器定義。

另請參閱