Aracılığıyla paylaş


Hizmet İstatistiklerini Alma (Önizleme REST API'si)

için geçerlidir: 2023-07-01-Preview. Bu sürüm artık desteklenmiyor. Yükseltme hemen daha yeni bir sürüme.

Önemli

2023-07-01-Preview, kapsamı arama hizmeti olarak belirlenmiş vectorIndexSize ekler.

2021-04-30-Preview, aliasesCountekler.

Hizmet İstatistikleri işlemi hizmetinizdeki nesnelerin sayısını ve türünü, hizmet katmanı, gerçek ve en yüksek depolama alanı ve katmana göre değişen diğer sınırlar için izin verilen her nesne türü için izin verilen en yüksek değeri döndürür. Bu istek hizmetten bilgi alır, böylecehizmet sınırlarını aramanız veya hesaplamanız gerekmez.

Belge sayısı ve depolama boyutuyla ilgili istatistikler gerçek zamanlı olarak değil, birkaç dakikada bir toplanır. Bu nedenle, bu API tarafından döndürülen istatistikler son dizin oluşturma işlemlerinin neden olduğu değişiklikleri yansıtmayabilir.

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

URI Parametreleri

Parametre Tarif
hizmet adı Gerekli. Bu değeri arama hizmetinizin benzersiz, kullanıcı tanımlı adına ayarlayın. İstek URI'si, istatistiklerin döndürülmesi gereken dizinin adını belirtir.
api sürümü Gerekli. Daha fazla sürüm için bkz. API sürümleri.

İstek Üst Bilgileri

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

Alanları Tarif
İçerik Türü Gerekli. Bu değeri application/json olarak ayarlayın
api-key İsteğe bağlı olarak Azure rollerini kullanıyorsanız ve istekte taşıyıcı belirteç sağlanıyorsa bir anahtar gereklidir. Api anahtarı, arama hizmetinizde isteğin kimliğini doğrulayan benzersiz, sistem tarafından oluşturulan bir dizedir. Arama hizmetine yönelik istekleri alma, yönetici anahtarınız (sorgu anahtarı yerine) olarak ayarlanmış bir api-key üst bilgisi içermelidir. Ayrıntılar için bkz. Anahtar kimlik doğrulaması kullanarak Azure AI Search'e bağlanma.

İstek Gövdesi

Hiç kimse.

Yanıt

Durum Kodu: Başarılı bir yanıt için "200 Tamam" döndürülür. Yanıt gövdesi aşağıdaki biçimdedir:

{
    "counters": {
        "documentCount": {
            "usage": number,
            "quota": number | null (if the service has unlimited document counts, the quota will be null)
        },
        "indexesCount": {
            "usage": number,
            "quota": number
        },
        "indexersCount": {
            "usage": number,
            "quota": number
        },
        "dataSourcesCount": {
            "usage": number,
            "quota": number
        },
        "storageSize": {
            "usage": number (bytes),
            "quota": number (bytes) 
        },
        "synonymMaps": {
            "usage": number,
            "quota": number
        },
        "aliasesCount": {
            "usage": number,
            "quota": number
        },
        "vectorIndexSize": {
            "usage": number (bytes),
            "quota": number (bytes)
        }
    },
    "limits": {
        "maxFieldsPerIndex": number,
        "maxIndexerRunTime": string,
        "maxFileExtractionSize": number,
        "maxFileContentCharactersToExtract": number,
        "maxFieldNestingDepthPerIndex": number,
        "maxComplexCollectionFieldsPerIndex": number,
        "maxComplexObjectsInCollectionsPerDocument": number
    }
}
Istatistik Tür Tarif
documentCount Saymak Tüm dizinlerdeki tüm belgelerin bir toplaması. Azure AI Search'ün ilk sürümleri belge sayısı sınırlarını zorunlu kıldı, ancak bu sınır artık yok. Kota her zaman null olduğundan hizmetin sınırsız belge sayısı olabilir.
indexesCount Saymak Arama hizmetindeki dizin sayısı. En fazla dizin sayısı, kota tarafından bildirildiği gibi katmana göre değişir.
indexersCount Saymak Arama hizmetindeki dizin oluşturucuların sayısı. En fazla dizin oluşturucu sayısı, kota tarafından bildirilen katmana göre farklılık gösterir.
dataSourcesCount Saymak Arama hizmetindeki veri kaynaklarının sayısı. Maksimum veri kaynakları, kota tarafından bildirilen katmana göre farklılık gösterir. En fazla veri kaynağı sayısı, en fazla dizin oluşturucu sayısıyla aynıdır.
aliasesCount Saymak Arama hizmetindeki dizin diğer adlarının sayısı. Kota tarafından bildirilen maksimum değer katmana göre değişir.
synonymMaps Saymak Arama hizmetindeki eş anlamlı eşlemelerin sayısı. Kota tarafından bildirilen maksimum değer katmana göre değişir.
storageSize Bayt Kullanım, hizmet üzerindeki tüm nesneler tarafından kullanılan depolama alanıdır. Kota, hizmetiniz için yapılandırılan bölüm sayısına ve boyutuna göre kullanılabilir en yüksek depolama alanıdır. Arama hizmetinde sağlanan bölüm sayısına yanıt olarak kota artar ve azalır. Bölüm boyutu katmana göre değişir.
vectorIndexSize Bayt Vektör dizini, arama dizininde tanımlandığı gibi vektör alanı başına bir vektör dizini olan bir iç yapıdır. Arama hizmetinizin vektör dizini sınırına göre vektör alanı tüketimini izleyebilmek için hizmet genelinde toplam kullanım bildirilir. Kota, arama hizmetinin yaşına, bölüm sayısına ve katmana göre belirlenen bölümlerin boyutuna göre değişir.

Tüm sınırlar hakkında daha fazla bilgi için bkz. Hizmet sınırları.

Örnekler

Bu API veri düzlemidir. Katman veya konum gibi bir hizmet hakkında daha fazla bilgi edinmek için bkz. Management REST API.

{
    "@odata.context": "https://my-search-service.search.windows.net/$metadata#Microsoft.Azure.Search.V2019_05_06.ServiceStatistics",
    "counters": {
        "documentCount": {
            "usage": 5072,
            "quota": null
        },
        "indexesCount": {
            "usage": 10,
            "quota": 15
        },
        "indexersCount": {
            "usage": 8,
            "quota": 15
        },
        "dataSourcesCount": {
            "usage": 9,
            "quota": 15
        },
        "storageSize": {
            "usage": 22265221,
            "quota": 2147483648
        },
        "synonymMaps": {
            "usage": 0,
            "quota": 3
        },
        "aliasesCount": {
            "usage": 7,
            "quota": 30
        },
        "vectorIndexSize": {
            "usage": 1342476,
            "quota": 1073741824
    },
    "limits": {
        "maxFieldsPerIndex": 1000,
        "maxIndexerRunTime": "P1D",
        "maxFileExtractionSize": 16777216,
        "maxFileContentCharactersToExtract": 65536,
        "maxFieldNestingDepthPerIndex": 10,
        "maxComplexCollectionFieldsPerIndex": 40,
        "maxComplexObjectsInCollectionsPerDocument": 3000
    }
}

Ayrıca bkz.

  • Azure AI Arama REST API'lerini