API CrawlingInfo

Vue d’ensemble

L’API CrawlingInfo permet de consulter et de gérer les informations de crawl (sessions de crawl) de Fess. Vous pouvez obtenir la liste des sessions de crawl, les consulter individuellement, les supprimer, etc.

URL de base

/api/admin/crawlinginfo

Liste des endpoints

Méthode Chemin Description
GET /logs Obtention de la liste des informations de crawl
GET /log/{id} Obtention d’une information de crawl
DELETE /log/{id} Suppression d’une information de crawl
DELETE /all Suppression groupée des sessions de crawl (hors sessions en cours)

Obtention de la liste des informations de crawl

Requête

GET /api/admin/crawlinginfo/logs

Paramètres

Paramètre Type Requis Description
size Integer Non Nombre d’éléments par page (défaut : 20)
page Integer Non Numéro de page (base 1, défaut : 1)
sessionId String Non Filtre par ID de session (correspondance partielle)

Réponse

{
  "response": {
    "status": 0,
    "logs": [
      {
        "id": "crawling_info_id_1",
        "sessionId": "20250129100000",
        "name": "Default Crawler",
        "expiredTime": "1738200000000",
        "createdTime": 1738108800000
      },
      {
        "id": "crawling_info_id_2",
        "sessionId": "20250128100000",
        "name": "Default Crawler",
        "expiredTime": "1738113600000",
        "createdTime": 1738022400000
      }
    ],
    "total": 10
  }
}

Champs de la réponse

Champ Description
id ID de l’information de crawl
sessionId ID de la session
name Nom de la session
expiredTime Date d’expiration (millisecondes epoch ; retournée sous forme de chaîne)
createdTime Heure de création (millisecondes epoch ; retournée sous forme de nombre)

Note

Chaque objet de journal dans la réponse inclut également un champ interne crudMode (un entier indiquant le mode d’opération CRUD, toujours 0 pour les opérations de lecture). Les clients peuvent l’ignorer en toute sécurité.

Obtention d’une information de crawl

Requête

GET /api/admin/crawlinginfo/log/{id}

Réponse

{
  "response": {
    "status": 0,
    "log": {
      "id": "crawling_info_id_1",
      "sessionId": "20250129100000",
      "name": "Default Crawler",
      "expiredTime": "1738200000000",
      "createdTime": 1738108800000
    }
  }
}

Suppression d’une information de crawl

Requête

DELETE /api/admin/crawlinginfo/log/{id}

Réponse

{
  "response": {
    "status": 0
  }
}

Suppression groupée des sessions de crawl

Supprime toutes les sessions de crawl (ainsi que leurs données de paramètres), à l’exception de celles qui sont actuellement en cours d’exécution. Il n’y a pas de seuil d’âge ou de durée ; toute session qui n’est pas en cours d’exécution est supprimée.

Requête

DELETE /api/admin/crawlinginfo/all

Réponse

{
  "response": {
    "status": 0
  }
}

Exemples d’utilisation

Obtention de la liste des informations de crawl

curl -X GET "http://localhost:8080/api/admin/crawlinginfo/logs?size=50&page=1" \
     -H "Authorization: Bearer YOUR_TOKEN"

Filtrage par session spécifique

curl -X GET "http://localhost:8080/api/admin/crawlinginfo/logs?sessionId=20250129100000" \
     -H "Authorization: Bearer YOUR_TOKEN"

Obtention d’une information de crawl

curl -X GET "http://localhost:8080/api/admin/crawlinginfo/log/crawling_info_id_1" \
     -H "Authorization: Bearer YOUR_TOKEN"

Suppression d’une information de crawl

curl -X DELETE "http://localhost:8080/api/admin/crawlinginfo/log/crawling_info_id_1" \
     -H "Authorization: Bearer YOUR_TOKEN"

Suppression groupée des sessions

curl -X DELETE "http://localhost:8080/api/admin/crawlinginfo/all" \
     -H "Authorization: Bearer YOUR_TOKEN"

Informations complémentaires