Dizin Oluşturucu Durumunu Alma (Azure AI Arama REST API'si)

Makale
11/13/2023

Dizin Oluşturucu Durumunu Al işlemi, bir dizin oluşturucunun geçerli durumunu ve yürütme geçmişini alır:

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

URI Parametreleri

Parametre	Açıklama
hizmet adı	Gereklidir. Bunu arama hizmetinizin benzersiz, kullanıcı tanımlı adı olarak ayarlayın.
dizin oluşturucu adı	Gereklidir. İstek URI'si, durumunun döndürülmesi gereken dizin oluşturucunun adını belirtir.
api-sürümü	Gereklidir. Geçerli kararlı sürüm şudur: `api-version=2020-06-30`. Daha fazla sürüm için bkz. API sürümleri.
failIfCannotDecrypt	İsteğe bağlı, belirtilmezse varsayılan olarak true olur. Dizin oluşturucu bir şifreleme anahtarı kullanılarak oluşturulduysa ve arama hizmetinin şifreleme anahtarına erişimi yoksa dizin oluşturucu durumunu alma işlemi başarısız olur. False ise, döndürülen dizin oluşturucu durumu, şifrelenmiş özelliklerin yerini yer tutucularla almıştır `"<encrypted>"` .

İstek Üst Bilgileri

Aşağıdaki tabloda gerekli ve isteğe bağlı istek üst bilgileri açıklanmaktadır.

Alanlar Description

İçerik Türü Gereklidir. Bunu olarak ayarlayın application/json

api-key İsteğe bağlı olarak, Azure rollerini kullanıyorsanız ve istekte taşıyıcı belirteç sağlanırsa, aksi takdirde bir anahtar gereklidir. Api anahtarı, arama hizmetinizde isteğin kimliğini doğrulayan, sistem tarafından oluşturulan benzersiz bir dizedir. Nesne tanımına yönelik alma istekleri, yönetici anahtarınıza ayarlanmış bir api anahtarı alanı içermelidir (sorgu anahtarının aksine). Ayrıntılar için bkz. Anahtar kimlik doğrulamasını kullanarak Azure AI Search'e bağlanma .

Alanlar	Description
İçerik Türü	Gereklidir. Bunu olarak ayarlayın `application/json`
api-key	İsteğe bağlı olarak, Azure rollerini kullanıyorsanız ve istekte taşıyıcı belirteç sağlanırsa, aksi takdirde bir anahtar gereklidir. Api anahtarı, arama hizmetinizde isteğin kimliğini doğrulayan, sistem tarafından oluşturulan benzersiz bir dizedir. Nesne tanımına yönelik alma istekleri, yönetici anahtarınıza ayarlanmış bir api anahtarı alanı içermelidir (sorgu anahtarının aksine). Ayrıntılar için bkz. Anahtar kimlik doğrulamasını kullanarak Azure AI Search'e bağlanma .

İstek Gövdesi

Yok.

Yanıt

Durum Kodu: Başarılı bir yanıt için 200 Tamam. Yanıt gövdesi genel dizin oluşturucu sistem durumu, son dizin oluşturucu çağrısı ve son dizin oluşturucu çağrılarının geçmişi (varsa) hakkında bilgi içerir.

Örnek yanıt gövdesi şöyle görünür:

{
    "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" : "",
                    "name" : "The operation name describing where the error occurred. For example, 'Enrichment.LanguageDetectionSkill.SkillName'",
                    "errorMessage" : "Document key cannot be missing or empty.",
                    "statusCode" : 400,
                    "details" : "Any additional details, such as the WebApi response if executing a custom skill failed.",
                    "documentationLink" : "A link to relevant documentation. For example, 'https://go.microsoft.com/fwlink/?linkid=2099692'""
                }
            ],
            "warnings" : [
                {
                    "key" : "document id",
                    "name" : "The operation name describing where the warning occurred. For example, 'Enrichment.LanguageDetectionSkill.SkillName'",
                    "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."
                    "details" : "Any additional details, such as the WebApi response if executing a custom skill failed.",
                    "documentationLink" : "A link to relevant documentation. For example, 'https://go.microsoft.com/fwlink/?linkid=2099692'"
                }
            ],
            "itemsProcessed" : 1,
            "itemsFailed" : 1,
            "initialTrackingState" : null,
            "finalTrackingState" : null
        }
    ]
}

Not

Dizin oluşturucu bir şifreleme anahtarı kullanılarak oluşturulduysa, durumun şifrelenmiş özellikleri yalnızca arama hizmetinin şifreleme anahtarına erişimi varsa alınabilir. Arama hizmetinin şifreleme anahtarına erişimi yoksa varsayılan olarak 400 Hatalı İstek döndürülür. Durumu, şifrelenmiş özellikleri değiştiren yer tutucularla "<encrypted>" almak için belirtinfailIfCannotDecrypt=false.