/policyengine/v1/policies/<policy_name>/status:GET

Obtient le statut de la règle.

Le noeud final status extrait les informations de statut de règle pour une règle spécifique.

La réponse inclut les informations suivantes:
  • total_count
  • nombre_terminé
  • nombre_échecs
  • nombre_soumissions_à_soumettre
  • start_time
  • End_Time

La réponse renvoyée dépend de trois scénarios de stratégie possibles. Il s'agit notamment de "Never Run", "Running" et "Finished". Si la règle n'est jamais exécutée (jamais exécutée), la réponse ne renvoie que le statut de la règle.

Si la règle est en cours d'exécution, les comptages mentionnés dans la liste précédente contiennent les valeurs en cours et aucune heure de fin n'est renvoyée.

Si la règle est terminée, les comptages contiennent les valeurs finales et une heure de fin est renvoyée.

Le tableau suivant affiche les rôles qui peuvent accéder au noeud final de l'API REST.
Tableau 1. Accès par rôle
Administrateur de données Utilisateur de données Administrateur de collection Utilisateur de collection Administrateur Utilisateur de maintenance
✓ 1✓ 1✓ ✓ Χ Χ
1 Les utilisateurs dotés du rôle Administrateur de collections peuvent accéder à ce noeud final uniquement s'ils sont propriétaires de la règle ou s'ils peuvent accéder à une ou plusieurs collections incluses dans la règle.

Les utilisateurs ayant le rôle Utilisateur de données peuvent accéder au noeud final uniquement s'ils sont propriétaires de la règle.

Résumé de la demande URL

curl -k -H 'Authorization: Bearer <token>' https://<data_cataloging_host>/policyengine/v1/ policies/<policy_name>/status -X GET -H ’Accept: application/json’

Types de demande et formats de réponse pris en charge

Types de demande pris en charge:
  • GET
Formats de réponse pris en charge:
  • JavaScript Object Notation

Exemples

L'exemple suivant renvoie des informations de statut de règle concernant une règle spécifique.

Emettez la demande suivante sur une seule ligne:

curl -k -H 'Authorization: Bearer <token>' https://<data_cataloging_host> /policyengine/v1/policies/policy1/status -X GET -H ’Accept: application/json’
La réponse suivante est renvoyée:
{
    "status": "running",
    "total_count": 15000,
    "completed_count": 14000,
    "failed_count": 0,
    "submitted_count": 15000,
    "start_time": "2020-03-27_11:12:10"
}