La API de automatización de flujo de trabajo le permite crear, gestionar y ejecutar mediante programación flujo de trabajo en New Relic. Emplee estas API para automatizar tareas repetitivas, orquestar operaciones complejas e integrar el flujo de trabajo en sus procesos de desarrollo y operaciones.
Antes de que empieces
Para emplear las API de automatización del flujo de trabajo, necesitará:
- Una cuenta de New Relic con las licencias adecuadas.
- Acceso al explorador de la API de NerdGraph para crear y probar tu APIde llamadas.
- Conocimiento de NerdGraph (la API GraphQL de New Relic)
Para obtener ayuda adicional:
- Aprende a usar el IDE de GraphiQL en el tutorial del explorador de la API de NerdGraph.
- Consulte la Introducción a las API para obtener una descripción general de todas las API de New Relic.
Autenticación y secretos
flujo de trabajo Automation emplea el almacenamiento secreto de los clientes para gestionar información confidencial como clave de API y credenciales. Los secretos se gestionan a través de nuestra API GraphQL. Para obtener detalles de autenticación relacionados con la gestión de secretos, consulte la documentación de NerdGraph.
Crear y gestionar flujo de trabajo.
Emplee estas API para crear, actualizar, validar y eliminar definiciones de flujo de trabajo:
- CrearDefiniciónDeFlujoDeTrabajo - Crear una nueva definición de flujo de trabajo
- Actualizar definición de flujo de trabajo : actualizar una definición de flujo de trabajo existente.
- ValidateWorkflowDefinition : valida la definición del flujo de trabajo en formato YAML antes de crearlo o actualizarlo.
- EliminarDefiniciónDeFlujoDeTrabajo - Elimina todas las versiones de una definición de flujo de trabajo con el nombre especificado.
consulta flujo de trabajo y acciones
Emplee estas API para recuperar información sobre el flujo de trabajo y las acciones disponibles:
- GetWorkflowDefinition - Obtiene y devuelve una definición de flujo de trabajo específica.
- GetWorkflowDefinitions : obtiene y devuelve una lista de definiciones de flujo de trabajo dentro del alcance de su cuenta.
- GetActionDefinitions - Devuelve todas las definiciones de acción disponibles
Flujo de trabajo en ejecución
Emplee estas API para controlar la ejecución del flujo de trabajo:
- IniciarEjecuciónDeFlujoDeTrabajo - Inicia la ejecución de un flujo de trabajo para una definición de flujo de trabajo específica.
- SignalWorkflowRun : activa una señal en un flujo de trabajo en ejecución existente.
- StopWorkflowRun - Detener una instancia de flujo de trabajo en ejecución
- WorkflowRunInfo : recupera información sobre una ejecución de flujo de trabajo específica
Horario de trabajo
Emplee estas API para crear y gestionar programaciones de flujo de trabajo:
- CrearProgramación - Crea una programación para una definición de flujo de trabajo
- GetSchedule - Obtener y devolver detalles del horario
- GetSchedules - Devuelve información sobre todos los horarios
- Eliminar programación : elimina la programación de una definición de flujo de trabajo.
Importante
Eliminar un horario no deja de ejecutar flujo de trabajo instancia.
Documentación de referencia
- Esquema de definición : referencia de la estructura y sintaxis de la definición del flujo de trabajo.