Indexers - Get Status

Hizmet:
Search Service
API Sürümü:
2023-10-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=2023-10-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

SearchError

Hata yanıtı.

Örnekler

SearchServiceGetIndexerStatus

Örnek isteği

GET https://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2023-10-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
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ütmesinin durumunu ayrıntılarıyla açıklar.
IndexerStatus

Genel dizin oluşturucu durumunu temsil eder.
IndexingMode

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

API için bir hata koşulu açıklar.
SearchIndexerError

Öğe veya belge düzeyi 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.

IndexerCurrentState

Nesne

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

Name Tür Description
allDocsFinalChangeTrackingState

string

Dizin oluşturma, veri kaynağındaki tüm belgelerde 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ırlayın.
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

Nesne

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 (date-time)

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 (int32)

Bu dizin oluşturucu yürütmesi sırasında dizinlenemeyen öğe sayısı.
itemsProcessed

integer (int32)

Bu dizin oluşturucu yürütmesi sırasında işlenen öğe 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 (date-time)

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üzeyi dizin oluşturma uyarıları.

IndexerExecutionStatus

Numaralandırma

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

Değer Description
transientFailure

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.
success

Dizin oluşturucu yürütmesi başarıyla tamamlandı.
inProgress

Dizin oluşturucu yürütmesi devam ediyor.
reset

Dizin oluşturucu sıfırlandı.

IndexerExecutionStatusDetail

Numaralandırma

Tek bir dizin oluşturucu yürütmesinin durumunu ayrıntılarıyla açıklar.

Değer Description
resetDocs

Gerçekleşen sıfırlamanın ResetDocs çağrısı için olduğunu gösterir.

IndexerStatus

Numaralandırma

Genel dizin oluşturucu durumunu temsil eder.

Değer Description
unknown

Dizin oluşturucunun bilinmeyen bir durumda olduğunu gösterir.
error

Dizin oluşturucunun insan müdahalesi olmadan düzeltilemeyen bir hatayla karşılaştığını gösterir.
running

Dizin oluşturucunun normal çalıştığını gösterir.

IndexingMode

Numaralandırma

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

Değer Description
indexingAllDocs

Dizin oluşturucu, veri kaynağındaki tüm belgelerin dizinini oluşturur.
indexingResetDocs

Dizin oluşturucu seçmeli dizin oluşturur, veri kaynağındaki belgeleri sıfırlar. Dizine alınan belgeler dizin oluşturucu durumunda tanımlanır.

SearchError

Nesne

API için bir hata koşulu açıklar.

Name Tür Description
code

string

Sunucu tanımlı hata kodları kümesinden biri.
details

SearchError[]

Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.
message

string

Hatanın insan tarafından okunabilir bir gösterimi.

SearchIndexerError

Nesne

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

Name Tür Description
details

string

Ek olarak, dizin oluşturucuda hata ayıklamaya yardımcı olmak için hatayla ilgili 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şturma işleminin 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 (int32)

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

Nesne
Name Tür Description
maxDocumentContentCharactersToExtract

number (int64)

Dizin oluşturma için alınan bir belgeden ayıklanacak karakter sayısı üst sınırı.
maxDocumentExtractionSize

number (int64)

Bir belgenin bayt cinsinden en büyük boyutu, dizin oluşturma için geçerli kabul edilir.
maxRunTime

string (duration)

Dizin oluşturucunun bir yürütme için çalışmasına izin verilen en uzun süre.

SearchIndexerStatus

Nesne

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

Name Tür Description
executionHistory

IndexerExecutionResult[]

Ters kronolojik düzende 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

Nesne

Öğ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 ayrıntılı ek ayrıntılar. Bu her zaman kullanılamayabilir.
documentationLink

string

Bu uyarı sınıfları için sorun giderme kılavuzu 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.