Indexers - Get Status

Başvuru

Hizmet:: Search Service

API Sürümü:: 2024-05-01-preview

Dizin oluşturucunun geçerli durumunu ve yürütme geçmişini döndürür.

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2024-05-01-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	Arama hizmetinin uç nokta URL'si.
indexerName	path	True	string	Durumunun alındığı dizin oluşturucunun adı.
api-version	query	True	string	İstemci Api Sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-request-id		string uuid	Hata ayıklamaya yardımcı olmak için istekle birlikte gönderilen izleme kimliği.

Yanıtlar

Name	Tür	Description
200 OK	SearchIndexerStatus
Other Status Codes	ErrorResponse	Hata yanıtı.

Örnekler

SearchServiceGetIndexerStatus

Örnek isteği

HTTP

GET https://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2024-05-01-preview

Örnek yanıt

Durum kodu:: 200

{
  "status": "running",
  "lastResult": {
    "status": "success",
    "errorMessage": null,
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "errors": [],
    "warnings": [],
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "initialTrackingState": null,
    "finalTrackingState": null
  },
  "executionHistory": [
    {
      "status": "success",
      "errorMessage": null,
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "errors": [],
      "warnings": [],
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "initialTrackingState": null,
      "finalTrackingState": null
    },
    {
      "status": "transientFailure",
      "errorMessage": null,
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "errors": [
        {
          "key": "",
          "errorMessage": "Document key cannot be missing or empty.",
          "statusCode": 400,
          "name": null,
          "details": null,
          "documentationLink": null
        },
        {
          "key": "document id 1",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "details": "The file could not be parsed.",
          "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388"
        }
      ],
      "warnings": [
        {
          "key": "document id",
          "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob.",
          "name": null,
          "details": null,
          "documentationLink": null
        },
        {
          "key": "document id 2",
          "message": "Document was truncated to 50000 characters.",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.",
          "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692"
        }
      ],
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "initialTrackingState": null,
      "finalTrackingState": null
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  }
}

Tanımlar

Name	Description
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
IndexerCurrentState	Dizin oluşturucunun geçerli yürütmesini tanımlayan ve dikte eden tüm durumu temsil eder.
IndexerExecutionResult	Tek bir dizin oluşturucu yürütmesinin sonucunu temsil eder.
IndexerExecutionStatus	Tek bir dizin oluşturucu yürütmesinin durumunu temsil eder.
IndexerExecutionStatusDetail	Tek bir dizin oluşturucu yürütme durumunun ayrıntıları.
IndexerStatus	Dizin oluşturucunun genel durumunu temsil eder.
IndexingMode	Dizin oluşturucunun yürütülmekte olduğu modu temsil eder.
SearchIndexerError	Öğe veya belge düzeyinde dizin oluşturma hatasını temsil eder.
SearchIndexerLimits
SearchIndexerStatus	Dizin oluşturucunun geçerli durumunu ve yürütme geçmişini temsil eder.
SearchIndexerWarning	Öğe düzeyi uyarıyı temsil eder.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

IndexerCurrentState

Dizin oluşturucunun geçerli yürütmesini tanımlayan ve dikte eden tüm durumu temsil eder.

Name	Tür	Description
allDocsFinalChangeTrackingState	string	Veri kaynağındaki tüm belgelerde dizin oluşturma tamamlandığında izleme durumu değerini değiştirin.
allDocsInitialChangeTrackingState	string	Veri kaynağındaki tüm belgelerde dizin oluşturma başlatılırken kullanılan değişiklik izleme durumu.
mode	IndexingMode	Dizin oluşturucunun çalıştığı mod.
resetDatasourceDocumentIds	string[]	Sıfırlanmış veri kaynağı belge kimliklerinin listesi. Veri kaynağı belge kimliği, veri kaynağındaki verilerin benzersiz tanımlayıcısıdır. Dizin oluşturucu, bu kimliklerin seçmeli olarak yeniden alımına öncelik verir.
resetDocsFinalChangeTrackingState	string	Dizin oluşturma seçildiğinde tamamlandığında izleme durumu değerini değiştirin, veri kaynağındaki belgeleri sıfırlayın.
resetDocsInitialChangeTrackingState	string	Dizin oluşturma seçildiğinde başlarken kullanılan değişiklik izleme durumu, veri kaynağındaki belgeleri sıfırlar.
resetDocumentKeys	string[]	Sıfırlanmış belge anahtarlarının listesi. Belge anahtarı, arama dizinindeki veriler için belgenin benzersiz tanımlayıcısıdır. Dizin oluşturucu bu anahtarların seçmeli olarak yeniden alımına öncelik verecek.

IndexerExecutionResult

Tek bir dizin oluşturucu yürütmesinin sonucunu temsil eder.

Name	Tür	Description
currentState	IndexerCurrentState	Dizin oluşturucunun geçerli yürütmesini tanımlayan ve dikte eden tüm durum.
endTime	string	Yürütme zaten tamamlandıysa, bu dizin oluşturucu yürütmesinin bitiş saati.
errorMessage	string	Varsa en üst düzey hatayı gösteren hata iletisi.
errors	SearchIndexerError[]	Öğe düzeyinde dizin oluşturma hataları.
finalTrackingState	string	Dizin oluşturucu yürütme işleminin tamamlandığı değişiklik izleme durumu.
initialTrackingState	string	Dizin oluşturucu yürütmenin başlatıldığı değişiklik izleme durumu.
itemsFailed	integer	Bu dizin oluşturucu yürütmesi sırasında dizine alınamayan öğelerin sayısı.
itemsProcessed	integer	Bu dizin oluşturucu yürütmesi sırasında işlenen öğelerin sayısı. Bu, hem başarıyla işlenen öğeleri hem de dizin oluşturmanın denendiği ancak başarısız olduğu öğeleri içerir.
startTime	string	Bu dizin oluşturucu yürütmesinin başlangıç saati.
status	IndexerExecutionStatus	Bu dizin oluşturucu yürütmesinin sonucu.
statusDetail	IndexerExecutionStatusDetail	Bu dizin oluşturucu yürütmesinin sonucu.
warnings	SearchIndexerWarning[]	Öğe düzeyinde dizin oluşturma uyarıları.

IndexerExecutionStatus

Tek bir dizin oluşturucu yürütmesinin durumunu temsil eder.

Name	Tür	Description
inProgress	string	Dizin oluşturucu yürütmesi devam ediyor.
reset	string	Dizin oluşturucu sıfırlandı.
success	string	Dizin oluşturucu yürütmesi başarıyla tamamlandı.
transientFailure	string	Dizin oluşturucu çağrısı başarısız oldu, ancak hata geçici olabilir. Dizin oluşturucu çağrıları her zamanlamaya göre devam eder.

IndexerExecutionStatusDetail

Tek bir dizin oluşturucu yürütme durumunun ayrıntıları.

Name	Tür	Description
resetDocs	string	Gerçekleşen sıfırlamanın ResetDocs çağrısına yönelik olduğunu gösterir.

IndexerStatus

Dizin oluşturucunun genel durumunu temsil eder.

Name	Tür	Description
error	string	Dizin oluşturucunun insan müdahalesi olmadan düzeltilemeyen bir hatayla karşılaştığını gösterir.
running	string	Dizin oluşturucunun normal çalıştığını gösterir.
unknown	string	Dizin oluşturucunun bilinmeyen bir durumda olduğunu gösterir.

IndexingMode

Dizin oluşturucunun yürütülmekte olduğu modu temsil eder.

Name	Tür	Description
indexingAllDocs	string	Dizin oluşturucu, veri kaynağındaki tüm belgelerin dizinini oluşturur.
indexingResetDocs	string	Dizin oluşturucu seçmeli dizin oluşturarak veri kaynağındaki belgeleri sıfırlar. Dizine alınan belgeler dizin oluşturucu durumunda tanımlanır.

SearchIndexerError

Öğe veya belge düzeyinde dizin oluşturma hatasını temsil eder.

Name	Tür	Description
details	string	Dizin oluşturucuda hata ayıklamaya yardımcı olmak için hatayla ilgili ek ayrıntılı ayrıntılar. Bu her zaman kullanılamayabilir.
documentationLink	string	Bu hata sınıfları için sorun giderme kılavuzunun bağlantısı. Bu her zaman kullanılamayabilir.
errorMessage	string	Öğe işlenirken oluşan hatayı açıklayan ileti.
key	string	Dizin oluşturmanın başarısız olduğu öğenin anahtarı.
name	string	Hatanın kaynaklandığı kaynağın adı. Örneğin, bu ekli beceri kümesindeki belirli bir beceriye işaret edebilir. Bu her zaman kullanılamayabilir.
statusCode	integer	Dizin oluşturma işleminin neden başarısız olduğunu gösteren durum kodu. Olası değerler şunlardır: Hatalı biçimlendirilmiş giriş belgesi için 400, belge bulunamadı için 404, sürüm çakışması için 409, dizin geçici olarak kullanılamadığında 422 veya hizmet çok meşgul olduğunda 503.

SearchIndexerLimits

Name	Tür	Description
maxDocumentContentCharactersToExtract	number	Dizin oluşturma için alınan bir belgeden ayıklanacak en fazla karakter sayısı.
maxDocumentExtractionSize	number	Bir belgenin bayt cinsinden en büyük boyutu, dizin oluşturma için geçerli kabul edilir.
maxRunTime	string	Dizin oluşturucunun bir yürütme için çalışmasına izin verilen en uzun süre.

SearchIndexerStatus

Dizin oluşturucunun geçerli durumunu ve yürütme geçmişini temsil eder.

Name	Tür	Description
executionHistory	IndexerExecutionResult[]	Ters kronolojik sırada sıralanmış son dizin oluşturucu yürütmelerinin geçmişi.
lastResult	IndexerExecutionResult	En son veya devam eden dizin oluşturucu yürütmesinin sonucu.
limits	SearchIndexerLimits	Dizin oluşturucu için yürütme sınırları.
status	IndexerStatus	Genel dizin oluşturucu durumu.

SearchIndexerWarning

Öğe düzeyi uyarıyı temsil eder.

Name	Tür	Description
details	string	Dizin oluşturucuda hata ayıklamaya yardımcı olmak için uyarıyla ilgili ek ayrıntılı ayrıntılar. Bu her zaman kullanılamayabilir.
documentationLink	string	Bu uyarı sınıfları için sorun giderme kılavuzunun bağlantısı. Bu her zaman kullanılamayabilir.
key	string	Uyarı oluşturan öğenin anahtarı.
message	string	Öğe işlenirken oluşan uyarıyı açıklayan ileti.
name	string	Uyarının kaynaklandığı kaynağın adı. Örneğin, bu ekli beceri kümesindeki belirli bir beceriye işaret edebilir. Bu her zaman kullanılamayabilir.

Aracılığıyla paylaş