ワークフロー自動化 API リファレンス

ワークフロー オートメーションAPI使用すると、 New Relicでワークフローをプログラムで作成、管理、実行できます。 これらの API を使用して、反復的なタスクを自動化し、複雑な操作を調整し、ワークフローを開発プロセスと運用プロセスに統合します。

あなたが始める前に

ワークフロー自動化 API を使用するには、次のものが必要です。

• 適切な権限を持つNew Relicアカウント
• NerdGraph APIエクスプローラーにアクセスしてAPIコールを作成し、テストします
• NerdGraph （New RelicのGraphQL API）の理解

さらにヘルプが必要な場合は、以下を参照してください。

• NerdGraph APIエクスプローラーチュートリアルでGraphiQL IDEの使い方を学びましょう
• New Relic APIの概要については、 APIの概要を参照してください。

認証と秘密

ワークフロー オートメーションは、 APIキーや資格情報などの機密情報を管理するために顧客秘密ストレージを使用します。 シークレットはGraphQL APIを通じて管理されます。秘密管理に関連する認証の詳細については、 NerdGraph のドキュメントを参照してください。

カテゴリ別API操作

ワークフローの作成と管理

ワークフロー定義を作成、更新、検証、および削除するには、次の API を使用します。

• CreateWorkflowDefinition - 新しいワークフロー定義を作成する
• UpdateWorkflowDefinition - 既存のワークフロー定義を更新する
• ValidateWorkflowDefinition - 作成または更新する前にワークフロー定義 YAML を検証します
• DeleteWorkflowDefinition - 指定された名前のワークフロー定義のすべてのバージョンを削除します

クエリのワークフローとアクション

ワークフローと利用可能なアクションに関する情報を取得するには、次の API を使用します。

• GetWorkflowDefinition - 特定のワークフロー定義を取得して返す
• GetWorkflowDefinitions - アカウントスコープ内のワークフロー定義のリストを取得して返します
• GetActionDefinitions - 利用可能なすべてのアクション定義を返します

ワークフローを実行する

ワークフローの実行を制御するには、次の API を使用します。

• StartWorkflowRun - 指定されたワークフロー定義のワークフロー実行を開始します
• SignalWorkflowRun - 実行中の既存のワークフローにシグナルをトリガーする
• StopWorkflowRun - 実行中のワークフローインスタンスを停止する

ワークフローのスケジュール

ワークフロー スケジュールを作成および管理するには、次の API を使用します。

• CreateSchedule - ワークフロー定義のスケジュールを作成する
• GetSchedule - スケジュールの詳細を取得して返す
• GetSchedules - すべてのスケジュールに関する情報を返します
• DeleteSchedule - ワークフロー定義のスケジュールを削除します

参照ドキュメント

• 定義スキーマ- ワークフロー定義の構造と構文リファレンス