Obtenir des statistiques de service (API REST en préversion)
s’applique à: 2023-07-01-Preview. Cette version n’est plus prise en charge. mettre à niveau immédiatement vers une version plus récente.
Important
2023-07-01-Preview ajoute vectorIndexSize étendue à un service de recherche.
2021-04-30-Preview ajoute aliasesCount.
L’opération Statistiques du service retourne le nombre et le type d’objets dans votre service, le nombre maximal autorisé pour chaque type d’objet en fonction du niveau de service, du stockage réel et maximal et d’autres limites qui varient selon le niveau. Cette demande extrait les informations du service afin que vous n’ayez pas à rechercher ou à calculer les limites de service .
Les statistiques sur le nombre de documents et la taille de stockage sont collectées toutes les quelques minutes, et non en temps réel. Par conséquent, les statistiques retournées par cette API peuvent ne pas refléter les modifications provoquées par les opérations d’indexation récentes.
GET https://[service name].search.windows.net/servicestats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Paramètres d’URI
| Paramètre | Description |
|---|---|
| nom du service | Obligatoire. Définissez cette valeur sur le nom unique défini par l’utilisateur de votre service de recherche. L’URI de requête spécifie le nom de l’index pour lequel les statistiques doivent être retournées. |
| api-version | Obligatoire. Consultez versions de l’API pour plus de versions. |
En-têtes de requête
Le tableau suivant décrit les en-têtes de requête obligatoires et facultatifs.
| Champs | Description |
|---|---|
| Type de contenu | Obligatoire. Définissez cette valeur sur application/json |
| api-key | Facultatif si vous utilisez rôles Azure et qu’un jeton du porteur est fourni sur la demande, sinon une clé est requise. Une clé API est une chaîne unique générée par le système qui authentifie la requête auprès de votre service de recherche. Obtenir des demandes sur le service de recherche doit inclure un en-tête api-key défini sur votre clé d’administration (par opposition à une clé de requête). Pour plus d’informations, consultez Se connecter à Azure AI Search à l’aide de l’authentification par clé. |
Corps de la demande
Aucun.
Réponse
Code d’état : « 200 OK » est retourné pour une réponse réussie. Le corps de la réponse est au format suivant :
{
"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
}
}
| Statistique | Type | Description |
|---|---|---|
| documentCount | Compter | Agrégation de tous les documents de tous les index. Les premières versions d’Azure AI Search appliquent des limites de nombre de documents, mais cette limite n’existe plus. Le quota est toujours null indiquant que le service peut avoir un nombre illimité de documents. |
| indexesCount | Compter | Nombre d’index sur le service de recherche. Les index maximum varient selon le niveau, comme indiqué par le quota. |
| indexersCount | Compter | Nombre d’indexeurs sur le service de recherche. Les indexeurs maximum varient selon le niveau, comme indiqué par le quota. |
| dataSourcesCount | Compter | Nombre de sources de données sur le service de recherche. Les sources de données maximales varient selon le niveau, comme indiqué par le quota. Les sources de données maximales sont le même nombre que les indexeurs maximum. |
| aliasesCount | Compter | Nombre d’alias d’index sur le service de recherche. La valeur maximale varie selon le niveau, comme indiqué par le quota. |
| synonymMaps | Compter | Nombre de mappages de synonymes sur le service de recherche. La valeur maximale varie selon le niveau, comme indiqué par le quota. |
| storageSize | Octets | L’utilisation est le stockage de quantité utilisé par tous les objets sur le service. Le quota est le stockage maximal disponible en fonction de la taille et du nombre de partitions configurées pour votre service. Le quota augmente et diminue en réponse au nombre de partitions approvisionnées dans le service de recherche. La taille de partition varie selon le niveau. |
| vectorIndexSize | Octets | Un index vectoriel est une structure interne, un index vectoriel par champ vectoriel tel que défini dans un index de recherche. L’utilisation totale est signalée sur l’ensemble du service afin de pouvoir surveiller la consommation d’espace vectoriel par rapport à la limite d’index vectoriel de votre service de recherche. Le quota varie selon l’âge du service de recherche, le nombre de partitions et la taille des partitions, comme déterminé par niveau. |
Pour plus d’informations sur toutes les limites, consultez Limites du service .
Exemples
Cette API est un plan de données. Pour obtenir plus d’informations sur un service, tel qu’il est de niveau ou d’emplacement, consultez l’API REST Gestion des.
{
"@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
}
}