Obtenir des statistiques d’index (API REST Azure AI Search)
L’opération Obtenir les statistiques d’index retourne à partir d’Azure AI Search un nombre de documents pour l’index actuel, ainsi que l’utilisation du stockage. Vous pouvez également obtenir ces informations à partir du portail.
Notes
Les statistiques sur le nombre de documents et la taille du stockage sont collectées à intervalles de quelques minutes, pas 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/indexes/[index name]/stats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Paramètres 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. |
| nom de l'index | Obligatoire. L’URI de requête spécifie le nom de l’index pour lequel les statistiques doivent être retournées. |
| api-version | Obligatoire. La version stable actuelle est api-version=2020-06-30. Pour plus d’informations, consultez Versions de l’API . |
En-têtes de requête
Le tableau suivant décrit les en-têtes de demande obligatoires et facultatifs.
| Champs | Description |
|---|---|
| Content-Type | Obligatoire. À définir avec la valeur application/json |
| api-key | Facultatif si vous utilisez des rôles Azure et qu’un jeton de 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 demande auprès de votre service de recherche. Les demandes d’obtention d’une définition d’objet doivent inclure un champ 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.
response
Code d’état : « 200 OK » est retourné pour une réponse réussie. Le corps de la réponse a le format suivant :
{
"documentCount": number,
"storageSize": number (size of the index in bytes)
}