L'API d'automatisation des workflows vous permet de créer, gérer et exécuter par programmation des workflows dans New Relic. Utilisez ces API pour automatiser les tâches répétitives, orchestrer des opérations complexes et intégrer le workflow à vos processus de développement et d'exploitation.
Avant de commencer
Pour utiliser les API d'automatisation des workflows, vous aurez besoin de :
- Un compte New Relic disposant des autorisations appropriées
- Accès à l' explorateur d'API NerdGraph pour créer et tester votre appel d'API
- Compréhension de NerdGraph (API GraphQL de New Relic)
Pour obtenir de l'aide supplémentaire :
- Apprenez à utiliser l'IDE GraphiQL grâce au tutoriel de l'explorateur d'API NerdGraph.
- Consultez la section Introduction aux API pour obtenir un aperçu de toutes les API de New Relic.
Authentification et secrets
L'automatisation des workflows utilise le stockage secret des clients pour gérer les informations sensibles telles que les clés API et les identifiants. Les secrets sont gérés via notre API GraphQL. Pour plus de détails sur l'authentification relative à la gestion des secrets, veuillez consulter la documentation NerdGraph.
Créer et gérer un workflow
Utilisez ces API pour créer, mettre à jour, valider et supprimer des définitions workflow :
- Créer une définition de workflow - Créer une nouvelle définition de workflow
- Mettre à jour la définition du workflow - Mettre à jour une définition de workflow existante
- ValidateWorkflowDefinition - Validez la définition du workflow YAML avant de créer ou de mettre à jour
- SupprimerDéfinitionDeFluxDeTravail - Supprime toutes les versions d'une définition de workflow portant le nom spécifié
Workflow et actions des requêtes
Utilisez ces API pour récupérer des informations sur le workflow et les actions disponibles :
- GetWorkflowDefinition - Obtenir et renvoyer une définition de workflow spécifique
- GetWorkflowDefinitions - Obtenir et renvoyer une liste de définitions de workflow sous votre périmètre de compte
- GetActionDefinitions - Renvoie toutes les définitions d'actions disponibles
Exécuter le workflow
Utilisez ces API pour contrôler l'exécution workflow :
- Démarrer l'exécution du workflow - Lancer l'exécution d'un workflow pour une définition de workflow spécifiée
- SignalWorkflowRun - Déclenche un signal vers un workflow en cours d'exécution.
- StopWorkflowRun - Arrêter une instance de workflow en cours d'exécution
- WorkflowRunInfo - Récupérer des informations sur une exécution de workflow spécifique
Planifier le workflow
Utilisez ces API pour créer et gérer des planifications workflow :
- Créer un planning - Créer un planning pour une définition de workflow
- GetSchedule - Obtenir et renvoyer les détails de l'horaire
- GetSchedules - Renvoie les informations sur tous les horaires
- SupprimerPlanification - Supprimer la planification d'une définition de workflow
Important
La suppression d'une planification n'arrête pas l'instance workflow déjà en cours d'exécution.
Documentation de référence
- Schéma de définition - Référence de la structure et de la syntaxe de la définition du workflow