A API de automação de fluxo de trabalho permite criar, gerenciar e executar programaticamente fluxo de trabalho no New Relic. Utilize essas APIs para automatizar tarefas repetitivas, orquestrar operações complexas e integrar o fluxo de trabalho aos seus processos de desenvolvimento e operações.
Antes de você começar
Para usar as APIs de Automação de Fluxo de Trabalho, você precisará de:
- Uma conta New Relic com as permissões apropriadas.
- Acesso ao explorador API do NerdGraph para criar e testar sua chamada de API
- Compreensão do NerdGraph (API GraphQL da New Relic)
Para obter ajuda adicional:
- Aprenda a usar o IDE GraphiQL no tutorial do explorador API da NerdGraph.
- Consulte a Introdução às APIs para obter uma visão geral de todas as APIs do New Relic.
Autenticação e segredos
fluxo de trabalho A automação utiliza o Secret Storage dos clientes para gerenciar informações confidenciais como chave de API e credenciais. Os segredos são gerenciados por meio de nossa API GraphQL. Para obter detalhes de autenticação relacionados ao gerenciamento de segredos, consulte a documentação do NerdGraph.
Criar e gerenciar fluxo de trabalho
Utilize estas APIs para criar, atualizar, validar e excluir definições de fluxo de trabalho:
- CriarDefiniçãoDeFluxoDeTrabalho - Criar uma nova definição de fluxo de trabalho
- AtualizarDefiniçãoDeFluxoDeTrabalho - Atualizar uma definição de fluxo de trabalho existente
- ValidarDefiniçãoDeFluxoDeTrabalho - Valida o YAML da definição do fluxo de trabalho antes de criar ou atualizar.
- DeleteWorkflowDefinition - Exclui todas as versões de uma definição de fluxo de trabalho com o nome especificado.
consulta fluxo de trabalho e ações
Utilize estas APIs para obter informações sobre fluxo de trabalho e ações disponíveis:
- GetWorkflowDefinition - Obtém e retorna uma definição de fluxo de trabalho específica.
- GetWorkflowDefinitions - Obtém e retorna uma lista de definições de fluxo de trabalho no escopo da sua conta.
- GetActionDefinitions - Retorna todas as definições de ação disponíveis.
Executar fluxo de trabalho
Utilize estas APIs para controlar a execução do fluxo de trabalho:
- IniciarExecuçãoDoFluxoDeTrabalho - Inicia a execução de um fluxo de trabalho para uma definição de fluxo de trabalho específica.
- SignalWorkflowRun - Aciona um sinal para um fluxo de trabalho em execução.
- StopWorkflowRun - Interrompe uma instância de fluxo de trabalho em execução.
- WorkflowRunInfo - Recupera informações sobre uma execução de fluxo de trabalho específica.
Cronograma de fluxo de trabalho
Utilize estas APIs para criar e gerenciar agendamentos de fluxo de trabalho:
- CriarAgenda - Criar um agendamento para uma definição de fluxo de trabalho
- GetSchedule - Obtenha e retorne detalhes da programação
- GetSchedules - Retorna informações sobre todos os horários
- DeleteSchedule - Exclui o agendamento de uma definição de fluxo de trabalho.
Importante
Excluir um agendamento não interrompe a execução do fluxo de trabalho da instância.
Documentação de referência
- Esquema de Definição - Estrutura de definição de fluxo de trabalho e referência de sintaxe