Indexers - Get Status
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=2026-11-01-preview
URI Parametreleri
| Veri Akışı Adı | İçinde | Gerekli | Tür | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Arama hizmetinin uç nokta URL'si. |
|
indexer
|
path | True |
string |
Dizin oluşturucunun adı. |
|
api-version
|
query | True |
string minLength: 1 |
Bu işlem için kullanılacak API sürümü. |
İstek Başlığı
| Veri Akışı Adı | Gerekli | Tür | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı. |
|
| Accept |
Accept başlığı. |
Yanıtlar
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| 200 OK |
İstek başarılı oldu. |
|
| Other Status Codes |
Beklenmeyen bir hata yanıtı. |
Güvenlik
api-key
Tür:
apiKey
İçinde:
header
OAuth2Auth
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Kapsamlar
| Veri Akışı Adı | Description |
|---|---|
| https://search.azure.com/.default |
Örnekler
|
Search |
|
Search |
SearchServiceGetIndexerStatus
Örnek isteği
GET https://typespecpreviewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2026-11-01-preview
Örnek yanıt
{
"name": "myindexer",
"status": "running",
"runtime": {
"usedSeconds": 0,
"beginningTime": "2024-06-06T00:00:00.000Z",
"endingTime": "2024-06-07T00:00:00.000Z"
},
"lastResult": {
"status": "success",
"startTime": "2014-11-26T03:37:18.853Z",
"endTime": "2014-11-26T03:37:19.012Z",
"itemsProcessed": 11,
"itemsFailed": 0,
"mode": "indexingAllDocs",
"errors": [],
"warnings": []
},
"executionHistory": [
{
"status": "success",
"startTime": "2014-11-26T03:37:18.853Z",
"endTime": "2014-11-26T03:37:19.012Z",
"itemsProcessed": 11,
"itemsFailed": 0,
"mode": "indexingAllDocs",
"errors": [],
"warnings": []
},
{
"status": "transientFailure",
"startTime": "2014-11-26T03:28:10.125Z",
"endTime": "2014-11-26T03:28:12.007Z",
"itemsProcessed": 1,
"itemsFailed": 2,
"mode": "indexingAllDocs",
"errors": [
{
"key": "",
"statusCode": 400,
"errorMessage": "Document key cannot be missing or empty."
},
{
"key": "document id 1",
"statusCode": 400,
"name": "DocumentExtraction.AzureBlob.MyDataSource",
"errorMessage": "Could not read the value of column 'foo' at index '0'.",
"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."
},
{
"key": "document id 2",
"name": "Enrichment.LanguageDetectionSkill.#4",
"message": "Document was truncated to 50000 characters.",
"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"
}
]
}
],
"limits": {
"maxRunTime": "PT22H",
"maxDocumentExtractionSize": 256000000,
"maxDocumentContentCharactersToExtract": 4000000
},
"currentState": {
"mode": "indexingAllDocs",
"resetDocumentKeys": [],
"resetDatasourceDocumentIds": []
}
}
SearchServiceGetS3HDUnlimitedIndexerStatus
Örnek isteği
GET https://typespecpreviewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2026-11-01-preview
Örnek yanıt
{
"name": "myindexer",
"status": "running",
"runtime": {
"usedSeconds": 0,
"remainingSeconds": 39600,
"beginningTime": "2024-06-06T00:00:00.000Z",
"endingTime": "2024-06-07T00:00:00.000Z"
},
"lastResult": {
"status": "success",
"startTime": "2014-11-26T03:37:18.853Z",
"endTime": "2014-11-26T03:37:19.012Z",
"itemsProcessed": 11,
"itemsFailed": 0,
"mode": "indexingAllDocs",
"errors": [],
"warnings": []
},
"executionHistory": [
{
"status": "success",
"startTime": "2014-11-26T03:37:18.853Z",
"endTime": "2014-11-26T03:37:19.012Z",
"itemsProcessed": 11,
"itemsFailed": 0,
"mode": "indexingAllDocs",
"errors": [],
"warnings": []
},
{
"status": "transientFailure",
"startTime": "2014-11-26T03:28:10.125Z",
"endTime": "2014-11-26T03:28:12.007Z",
"itemsProcessed": 1,
"itemsFailed": 2,
"mode": "indexingAllDocs",
"errors": [
{
"key": "",
"statusCode": 400,
"errorMessage": "Document key cannot be missing or empty."
},
{
"key": "document id 1",
"statusCode": 400,
"name": "DocumentExtraction.AzureBlob.MyDataSource",
"errorMessage": "Could not read the value of column 'foo' at index '0'.",
"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."
},
{
"key": "document id 2",
"name": "Enrichment.LanguageDetectionSkill.#4",
"message": "Document was truncated to 50000 characters.",
"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"
}
]
}
],
"limits": {
"maxRunTime": "PT22H",
"maxDocumentExtractionSize": 256000000,
"maxDocumentContentCharactersToExtract": 4000000
},
"currentState": {
"mode": "indexingAllDocs",
"resetDocumentKeys": [],
"resetDatasourceDocumentIds": []
}
}
Tanımlar
| Veri Akışı Adı | Description |
|---|---|
| Accept |
Accept başlığı. |
|
Error |
Kaynak yönetimi hatasına ilişkin ek bilgiler. |
|
Error |
Hata ayrıntısı. |
|
Error |
Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.). |
|
Indexer |
Dizin oluşturucunun geçerli yürütmesini tanımlayan ve dikte eden tüm durumu temsil eder. |
|
Indexer |
Tek bir dizin oluşturucu yürütmesinin sonucunu temsil eder. |
|
Indexer |
Tek bir dizin oluşturucu yürütmesinin durumunu temsil eder. |
|
Indexer |
Tek bir dizin oluşturucu yürütmesinin durumunu ayrıntılarıyla açıklar. |
|
Indexer |
Dizin oluşturucunun hizmetteki kümülatif çalışma zamanı tüketimini temsil eder. |
|
Indexer |
Genel dizin oluşturucu durumunu temsil eder. |
|
Indexing |
Dizin oluşturucunun yürütüldüğü modu temsil eder. |
|
Search |
Öğe veya belge düzeyi dizin oluşturma hatasını temsil eder. |
|
Search |
Bir indeksleyiciye uygulanabilecek sınırları temsil eder. |
|
Search |
Dizin oluşturucunun geçerli durumunu ve yürütme geçmişini temsil eder. |
|
Search |
Öğe düzeyi uyarıyı temsil eder. |
Accept
Accept başlığı.
| Değer | Description |
|---|---|
| application/json;odata.metadata=minimal |
ErrorAdditionalInfo
Kaynak yönetimi hatasına ilişkin ek bilgiler.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| info |
Ek bilgiler. |
|
| type |
string |
Ek bilgi türü. |
ErrorDetail
Hata ayrıntısı.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| additionalInfo |
Hata ek bilgisi. |
|
| code |
string |
Hata kodu. |
| details |
Hata ayrıntıları. |
|
| message |
string |
Hata iletisi. |
| target |
string |
Hata hedefi |
ErrorResponse
Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| error |
Hata nesnesi. |
IndexerCurrentState
Dizin oluşturucunun geçerli yürütmesini tanımlayan ve dikte eden tüm durumu temsil eder.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| allDocsFinalTrackingState |
string |
Dizin oluşturma, veri kaynağındaki tüm belgelerde tamamlandığında izleme durumu değerini değiştirin. |
| allDocsInitialTrackingState |
string |
Veri kaynağındaki tüm belgelerde dizin oluşturma başlatılırken kullanılan değişiklik izleme durumu. |
| mode |
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. |
| resetDocsFinalTrackingState |
string |
Dizin oluşturma seçildiğinde tamamlandığında izleme durumu değerini değiştirin, veri kaynağındaki belgeleri sıfırlayın. |
| resetDocsInitialTrackingState |
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. |
| resyncFinalTrackingState |
string |
Veri kaynağındaki seçmeli seçeneklerde dizin oluşturma tamamlandığında izleme durumu değerini değiştirin. |
| resyncInitialTrackingState |
string |
Veri kaynağındaki seçmeli seçeneklerde dizin oluşturma başladığında kullanılan değişiklik izleme durumu. |
IndexerExecutionResult
Tek bir dizin oluşturucu yürütmesinin sonucunu temsil eder.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| 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 |
Öğ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. |
| mode |
Dizin oluşturucunun çalıştığı mod. |
|
| startTime |
string (date-time) |
Bu dizin oluşturucu yürütmesinin başlangıç saati. |
| status |
Bu dizin oluşturucu yürütmesinin sonucu. |
|
| statusDetail |
Bu dizin oluşturucu yürütmesinin sonucu. |
|
| warnings |
Öğe düzeyi dizin oluşturma uyarıları. |
IndexerExecutionStatus
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ı zamanlamaya göre devam eder. |
| success |
Dizin oluşturucu yürütme başarıyla tamamlandı. |
| inProgress |
Dizin oluşturucu yürütme işlemi devam ediyor. |
| reset |
Dizin oluşturucu sıfırlandı. |
IndexerExecutionStatusDetail
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. |
| resync |
Veri kaynağındaki seçeneklere göre seçmeli olarak yeniden eşitleneceğini belirtir. |
IndexerRuntime
Dizin oluşturucunun hizmetteki kümülatif çalışma zamanı tüketimini temsil eder.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| beginningTime |
string (date-time) |
İndeksleyici çalışma zamanı kullanımı için dikkate alınan 24 saatlik UTC döneminin başlangıç UTC zamanı. |
| endingTime |
string (date-time) |
Dizin oluşturucu çalışma zamanı kullanımı (dahil) için dikkate alınan 24 saatlik sürenin bitiş UTC saati. |
| remainingSeconds |
integer (int64) |
Hizmetteki tüm dizin oluşturucular için başlangıçTime'dan bitişTime'a kadar saniye cinsinden kalan kümülatif çalışma zamanı. |
| usedSeconds |
integer (int64) |
Dizin oluşturucunun beginningTime ile bitişTime arasındaki kümülatif çalışma zamanı saniye cinsinden. |
IndexerStatus
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 şekilde çalıştığını gösterir. |
IndexingMode
Dizin oluşturucunun yürütüldüğü 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. |
| indexingResync |
Dizin oluşturucu, veri kaynağındaki seçmeli seçenekleri yeniden eşitler ve dizinler. |
SearchIndexerError
Öğe veya belge düzeyi dizin oluşturma hatasını temsil eder.
| Veri Akışı Adı | 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
Bir indeksleyiciye uygulanabilecek sınırları temsil eder.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| maxDocumentContentCharactersToExtract |
integer (int64) |
Dizin oluşturma için alınan bir belgeden ayıklanacak karakter sayısı üst sınırı. |
| maxDocumentExtractionSize |
integer (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
Dizin oluşturucunun geçerli durumunu ve yürütme geçmişini temsil eder.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| currentState |
Dizin oluşturucunun geçerli yürütmesini tanımlayan ve dikte eden durumun tümü. |
|
| executionHistory |
Ters kronolojik düzende sıralanmış son dizin oluşturucu yürütmelerinin geçmişi. |
|
| lastResult |
En son veya devam eden dizin oluşturucu yürütmesinin sonucu. |
|
| limits |
Dizin oluşturucu için yürütme sınırları. |
|
| name |
string |
Dizin oluşturucunun adı. |
| runtime |
Mevcut UTC döneminde hizmet için endeksleyicinin kümülatif çalışma süresi tüketiminin anlık görüntüsü. |
|
| status |
Genel dizin oluşturucu durumu. |
SearchIndexerWarning
Öğe düzeyi uyarıyı temsil eder.
| Veri Akışı Adı | 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. |