Tous les produits
Search
Centre de documentation

OpenSearch:ScheduledTask

Dernière mise à jour :Aug 21, 2026

Un objet ScheduledTask décrit une tâche de réindexation planifiée pour une application OpenSearch. Il contient la configuration de planification, l'état d'exécution actuel, le type de tâche ainsi que les conditions de filtrage des données.

Exemple

{
    "id": "cfd5ebe9-bcdd-11ea-a58d-98039b07e4ec",
    "progress": 0,
    "status": 3,
    "lastRanTimestamp": null,
    "type": "wipe",
    "running": false,
    "paused": false,
    "finished": false,
    "idle": true,
    "created": 1593747144,
    "updated": 1593747144,
    "cron": "0 0 * * 1,2,3,4,5,6,7",
    "enabled": true,
    "appId": null,
    "appGroupId": "100303899",
    "ownerId": "84",
    "lastScheduledTimestamp": null,
    "forkedAppId": "",
    "appGroup": {
        "id": "100303899"
    },
    "owner": {
        "id": "84"
    },
    "filter": {
        "field": "title",
        "days": 30,
        "unit": "s"
    }
}

Champs

Identité et propriété

Champ Type Description
id String ID de la tâche de réindexation planifiée.
appId String ID de la version.
appGroupId String ID de l'application.
appGroup.id String ID de l'application.
ownerId String ID du propriétaire.
owner.id String ID du propriétaire.
forkedAppId String ID de la version source servant de base à la réindexation.

Planification

Champ Type Description
cron String Expression cron définissant le calendrier de la tâche. Par exemple, 0 0 * * 1,2,3,4,5,6,7 exécute la tâche à minuit tous les jours. Pour la syntaxe cron complète, consultez la rubrique Champ Cron dans ScheduledTask.
enabled Boolean Indique si la tâche planifiée est activée.
lastScheduledTimestamp Integer/null Horodatage de la dernière planification de la tâche.
lastRanTimestamp Integer/null Horodatage de la dernière exécution de la tâche de réindexation planifiée.

Type de tâche

Champ Type Description
type String Type d'opération effectué par la tâche. Valeurs valides : wipe (suppression de données), fork (importation de données et réindexation), reindex (réindexation), clear (nettoyage des données).

État d'exécution

Champ Type Description
progress Integer Progression de la tâche de réindexation planifiée.
status Integer État actuel de la tâche. Valeurs valides : 0 (en cours d'exécution), 1 (suspendu), 2 (terminé), 3 (inactif).
running Boolean Indique si la tâche est en cours d'exécution. Correspond à la valeur 0 du champ status.
paused Boolean Indique si la tâche est suspendue. Correspond à la valeur 1 du champ status.
finished Boolean Indique si la tâche est terminée. Correspond à la valeur 2 du champ status.
idle Boolean Indique si la tâche est inactive et en attente de la prochaine exécution planifiée. Correspond à la valeur 3 du champ status.

Filtre de données

L'objet filter spécifie les données supprimées par la tâche selon l'expiration des champs.

Champ Type Description
filter Object Conditions utilisées pour identifier et supprimer les données expirées.
filter.field String Nom du champ d'index évalué par rapport aux paramètres d'expiration.
filter.days Integer Seuil d'expiration en jours. Les données plus anciennes que cette valeur sont supprimées. Valeurs valides : 7–180.
filter.unit String Unité de la valeur stockée dans filter.field. Valeurs valides : s (secondes), ms (millisecondes).