APIとCLI

Fleet Control 、API とコマンドライン インターフェイスを介した包括的なプログラム アクセスを提供し、 UIに依存せずにフリート操作の自動化、既存のツールとの統合、大規模な計装の管理を可能にします。

プログラムによるアクセスオプション

Fleet Control では、プログラムによるアクセスに 3 つの方法を提供しています。

• NerdGraph API :フリートの作成、メンバーの管理、デプロイメントの制御などのフリート管理操作用
• Blob Storage API :設定の作成、バージョン管理、取得などのエージェント設定操作用
• Fleet Control CLI:対話型のコマンドライン管理および自動化スクリプト用

API と CLI の使い分け

どのアクセス方法がユースケースに最適かを理解することで、Fleet Control をより効率的に使用できるようになります。

API (NerdGraph + Blob Storage API)

API は次の場合に最適です。

• 自動化と統合: Fleet ControlオペレーションをCI/CDパイプライン、カスタム ツール、またはその他の自動化されたワークフローに組み込む
• インフラストラクチャ as Code:インフラストラクチャ定義と並行してフリート設定を管理する
• システム間統合: Fleet Controlを他のプラットフォーム、チケット システム、またはオーケストレーション ツールと接続する
• 複雑なワークフロー:複数の操作を組み合わせたり、外部データソースと統合したりする高度な自動化を作成する
• プログラムによるアクセス: Fleet Control機能を独自のアプリケーションまたはサービスに構築する必要がある場合

Fleet Control CLI

CLI は次の場合に最適です。

• インタラクティブな操作:コマンドラインからの迅速な人間主導のタスク
• アドホック管理: 1回限りの管理操作またはトラブルシューティング
• ターミナルベースのワークフロー:ターミナルで直接作業したい場合
• ローカルテスト:自動化前のフリート運用の実験
• シェル スクリプト:単純な連続操作 (ただし、複雑な自動化には API の方が適している場合があります)
• 学習と探索: CLI は、 Fleet Control操作を理解するのに役立つ、即時の構造化されたフィードバックを提供します。

CLI は同じ API 上に構築されているため、機能的には同じ機能を提供します。選択はインターフェイスの好みとユースケースに依存します。つまり、人間による統合と利便性のための CLI、プログラムによる統合と自動化のための API です。

NerdGraph API（フリート運用）

NerdGraph は、フリート、メンバー、デプロイメントを管理するための Fleet Control 操作へのアクセスを提供する New Relic の GraphQL API です。エージェント設定 (Blob Storage APIを使用する) とは異なり、すべてのフリートレベルの操作は NerdGraph を使用します。

NerdGraphエクスプローラーへのアクセス

NerdGraph Explorer は、利用可能な Fleet Control API を検出し、クエリを構築し、操作をテストできるインタラクティブな GraphQL IDE です。

NerdGraph Explorer にアクセスするには:

1. お住まいの地域の NerdGraph Explorer に移動します。

   • 米国地域: https://one.newrelic.com/nerdgraph-graphiql
   • EU 地域: https://one.eu.newrelic.com/nerdgraph-graphiql

2. プロンプト時にユーザーAPIキーを入力します。 このリリースでは、アカウントに限定されたアクセス権を持つAPIエクスプローラーがリリースされます。

3. 左側のパネルで、 mutationを展開し、 fleetControlに移動して、利用可能なすべての Fleet Control 操作を表示します。

利用可能なFleet Control変異

NerdGraph API は、次の Fleet Control ミューテーションを提供します。

車両管理

• fleetControlCreateFleet - 新しい艦隊を作成する
• fleetControlUpdateFleet - 既存の艦隊のプロパティを更新する
• fleetControlDeleteFleet - 艦隊を削除する

フリートメンバー管理

• fleetControlAddFleetMembers - 管理対象エンティティをフリートリングに追加する
• fleetControlRemoveFleetMembers - フリートリングから管理対象エンティティを削除する

デプロイメント管理

• fleetControlCreateFleetDeployment - フリートの新しいデプロイメントを作成する
• fleetControlUpdateFleetDeployment - 既存のデプロイメントを更新する
• fleetControlDeleteFleetDeployment - デプロイメントを削除する
• fleetControlDeploy - デプロイメントをトリガーしてフリートリングに展開します

認証

すべての NerdGraph API requests New RelicユーザーAPIキーを使用した認証が必要です。 APIキーを生成するには:

1. one.newrelic.comにアクセスします
2. 左下隅にあるあなたの名前をクリックしてください
3. API Keys [APIキーを]選択
4. User [ユーザー]キーを作成します (Browserまたはライセンスキーではありません)

NerdGraph Explorer の外部でAPI呼び出しを行うときは、リクエスト ヘッダーにAPIキーを含めます。

NerdGraph の使用に関する詳細については、 「NerdGraph の概要」ドキュメントを参照してください。

Blob Storage API (エージェント設定)

Blob Storage API 、 Fleet Control内でエージェント設定を管理するために特別に設計された RESTful インターフェイスです。 このAPI 、設定の作成、バージョン管理、コンテンツの取得、削除など、設定に関連するすべての操作を処理します。

ベースエンドポイント

https://blob-api.service.newrelic.com/v1/e

認証

すべての Blob Storage API requests New RelicユーザーAPIキーを使用したApi-Keyヘッダーによる認証が必要です。

Api-Key: your-user-api-key

主な操作

Blob Storage API 、エージェント設定の次の操作をサポートしています。

エージェント設定の作成

組織内に新しいエージェント設定を作成します。

POST /v1/e/organizations/{orgId}/AgentConfigurations

必要なヘッダー:

• Api-Key - あなたのユーザーAPIキー
• Content-Type - application/x-yaml
• NewRelic-Entity - 設定メタデータを含む JSON (name、agentType、managedEntityType、configurationType)

リクエストボディ：エージェント設定のプレーンテキスト内容（YAML形式）

エージェント設定バージョンの作成

既存のエージェント設定の新しいバージョンを作成します。

POST /v1/e/organizations/{orgId}/AgentConfigurations/{parentConfigurationId}

必要なヘッダー:

• Api-Key - あなたのユーザーAPIキー
• Content-Type - application/x-yaml

リクエスト本文:新しい設定バージョンのプレーンテキストコンテンツ (YAML 形式)

注:親設定 ID は URL パスに指定されます。 バージョンの作成にはNewRelic-Entityヘッダーは必要ありません。

設定バージョンのコンテンツを取得する

特定の設定バージョンのコンテンツを取得します。

GET /v1/e/organizations/{orgId}/AgentConfigurationVersions/{configurationVersionId}

必要なヘッダー:

• Api-Key - あなたのユーザーAPIキー

レスポンス:設定内容をプレーンテキスト/YAMLとして返します

設定バージョンの削除

特定の設定バージョンを削除します。

DELETE /v1/e/organizations/{orgId}/AgentConfigurationVersions/{configVersionGuid}

必要なヘッダー:

• Api-Key - あなたのユーザーAPIキー

応答:削除が成功した場合は 2xx ステータス、設定バージョンが見つからない場合は 404

有効なフィールド値

エージェント設定を作成するときは、特定のフィールドに有効な値を指定する必要があります。

エージェントの種類

次のエージェント タイプがサポートされています。

インフラストラクチャエージェント(HOST および KUBERNETESCLUSTER で管理されるエンティティ タイプの場合):

• NRInfra - New Relic Infrastructure
• NRDOT - OpenTelemetry Collector の New Relic ディストリビューション
• FluentBit - Fluent Bit ロギングエージェント
• NRPrometheusAgent - プロメテウスエージェント
• PipelineControlGateway - Pipeline Controlゲートウェイ
• NRApmOperator - Kubernetes 用 APM オペレーター
• NReBPFAgent - eBPFエージェント

アプリケーションエージェント(アプリケーション管理エンティティタイプの場合):

• NRJavaAgent - Java APMエージェント
• NRPythonAgent - Python APMエージェント
• NRNodeAgent - Node.js APMエージェント
• NRRubyAgent - Ruby APMエージェント
• NRDotNetAgent - .NET APMエージェント

管理対象エンティティタイプ

• HOST - 個別のホスト/サーバー エンティティ (インフラストラクチャ エージェントのみを使用可能)
• KUBERNETESCLUSTER - Kubernetesクラスタエンティティ（インフラストラクチャエージェントのみ使用可能）
• APPLICATION - アプリケーション エンティティ (アプリケーション エージェントのみ使用可能)

設定タイプ

• Instrumentation - 現在サポートされている設定タイプ

ベストプラクティス

• HTTPステータスコードを常にチェックしてください。APIは操作が成功した場合200を返します。
• 返されたエンティティの GUID を保存します。バージョン管理と削除操作に必要になります。
• JSON フォーマットの検証: NewRelic-Entityヘッダーの JSON フォーマットが適切であることを確認します
• エージェントタイプの互換性を確認する:エージェントタイプが管理対象エンティティタイプと互換性があることを確認します。
• 正しいコンテンツタイプを使用してください:コンテンツの設定には常にapplication/x-yamlを使用してください
• APIキーを保護する:ユーザーAPIキーをクライアント側のコードやパブリック リポジトリで公開しないでください。

Fleet Control CLI

Fleet Control CLI は、フリート、設定、デプロイメント、メンバー、エンティティ記述を含むすべてのFleet Controlエンティティを管理するための包括的なコマンドライン インターフェイスです。 CLI は、対話型操作と自動化の両方に対して、構造化されたターミナルベースのワークフローを提供します。

指揮系統

Fleet Controlコマンドは、直感的なナビゲーションのためにリソース タイプ別に整理されています。

newrelic fleetcontrol
├── fleet                    # Fleet management
│   ├── create              # Create a new fleet
│   ├── get                 # Get fleet details
│   ├── search              # Search fleets
│   ├── update              # Update fleet
│   ├── delete              # Delete fleet(s)
│   └── members             # Manage fleet members
│       ├── add             # Add entities to ring
│       ├── remove          # Remove entities from ring
│       └── list            # List fleet members
│
├── configuration            # Configuration management
│   ├── create              # Create configuration
│   ├── get                 # Get configuration content
│   ├── delete              # Delete configuration
│   └── versions            # Manage configuration versions
│       ├── list            # List all versions
│       ├── add             # Add new version
│       └── delete          # Delete specific version
│
├── deployment               # Deployment management
│   ├── create              # Create deployment
│   ├── update              # Update deployment
│   ├── deploy              # Trigger deployment
│   └── delete              # Delete deployment
│
└── entities                 # Entity queries
    ├── get-managed         # List managed entities
    └── get-unassigned      # List available entities

主な機能

Fleet Control CLI を使用すると、次のことが可能になります。

• エージェント操作を一元化:コマンドラインからすべてのエージェントと統合をインストール、監視、構成、更新します。
• フリートの管理:計装ニーズ別にエンティティをグループ化し、フリート全体のエージェント バージョンをアップグレードします。
• 設定の作成とバージョン管理:エージェント設定を作成し、複数のバージョンを管理する
• デプロイメントの制御:リングベースのロールアウトを使用してデプロイメントを作成、更新、トリガーします
• エンティティのクエリ:管理対象エンティティと未割り当てエンティティを一覧表示して、フリートの状況を把握します。

前提条件

Fleet Control CLI コマンドを使用する前に、次のものが必要です。

必要な環境変数:

$
# Your New Relic User API Key
$
export NEW_RELIC_API_KEY="NRAK-YOUR-API-KEY-HERE"
$

$
# Your New Relic Account ID
$
export NEW_RELIC_ACCOUNT_ID="your-account-id"
$

$
# Optional: Specify region (defaults to US)
$
export NEW_RELIC_REGION="US"  # or "EU" for European accounts

資格情報の取得:

1. APIキー: one.newrelic.com → 名前をクリック → API Keys → Create a "User" key からユーザー API キーを生成します。
2. アカウントID:アカウントIDは、New Relic URLの/accounts/以降またはアカウント設定で確認できます。
3. 組織 ID:ほとんどのコマンドはオプションの--organization-idフラグを受け入れます。指定されない場合、CLI は API 認証情報を使用して組織 ID を自動的に取得します。

完全なCLIドキュメント

インストールとセットアップを含むNew Relic CLI の使用を開始する方法については、 New Relic CLI リポジトリを参照してください。

詳細な Fleet Control コマンド リファレンス、応答形式、検証ルール、およびトラブルシューティング ガイダンスについては、 Fleet Control CLI README を参照してください。

CLI ドキュメントには以下が含まれます。

• すべての操作の完全なコマンドリファレンス
• レスポンス形式の仕様
• JSONレスポンスの操作 jq
• 実用的なワークフローの例
• 検証ルールと許可された値
• よくある問題のトラブルシューティング
• フラグの構文と使用パターン

プログラムによるアクセスを始める

Fleet Control をプログラムで使い始めるには:

1. New Relicアカウント設定からGenerate a User API Key [ユーザーAPIキーを生成します]

2. New Relicプラットフォームからアカウント ID と組織 ID を特定します

3. アクセス方法を選択してください:

   • NerdGraph Explorerを使用して、艦隊の運用をインタラクティブに探索します。
   • 設定管理のためのBlob Storage API操作を確認する
   • ターミナルベースのワークフロー用にFleet Control CLIをインストールして構成する

4. データ構造に慣れるために読み取り操作から始めます(フリートの検索、エンティティのリスト、設定の取得)

5. スクリプトやワークフローに操作を組み合わせて段階的にビルド自動化

API に関する追加のヘルプについては、 NerdGraph の概要ドキュメントとAPIキー ドキュメントを参照してください。