Datadog API と Postman の使用
Datadog の調査レポート: サーバーレスの状態 レポート: サーバーレスの状態

Datadog API と Postman の使用

概要

Datadog API を使用すると、Datadog との間でデータをやり取りできます。Datadog API は、リソース指向の URL とステータスコードを使用してリクエストの成功または失敗を示し、すべてのリクエストから JSON を返します。

この記事では、Postman を使用して Datadog への API 呼び出しを実行する方法を説明します。記事内では、Datadog API 内で使用可能なアクションを示し、Postman を使用して GETPOSTPUT、および DELETE を実行するための高度な概要を提供します。

前提条件

以下が必要です。

セットアップ

Datadog コレクションのインポート

前提条件を満たしていれば、以下を実行します。

  1. Datadog Postman コレクション (事前に構成された API 呼び出しテンプレート) をダウンロードします。 Postman では、コレクションとは編集、保存、再利用を容易に行えるように API 呼び出しを整理してまとめたフォルダーを指します。

  2. Datadog Postman コレクションをインポートします。

    • Postman を開きます。
    • Importをクリックします。
    • 手順 1 でダウンロードした datadog_collection.json ファイルを選択します。

さまざまな API サンプルが入った Datadog コレクションが入手できました。

: この時点では API 呼び出しは機能しません。以下を参照して Datadog-Postman 環境を設定してください。

Postman 環境のセットアップ

Postman コレクションをインポートすると、Postman の左ペインに、使用できるすべての Datadog API 呼び出しの一覧がフォルダーで構造化されて示されます。 フォルダー内の API 呼び出しには、datadog_sitedatadog_api_keydatadog_application_key に対する変数が次のように入力されています。

これにより、Postman 環境をセットアップして、認証用の Datadog サイト、API、およびアプリケーションキーを保存できます。Datadog オーガニゼーションが複数ある場合は、複数の Postman 環境をセットアップすることにより、Datadog Postman コレクション内の API 呼び出しは変更しないまま各オーガニゼーションに対して API 呼び出しを実行できます。

以下の手順に従って環境をセットアップします。

  1. Postman の右上隅にある Manage Environments の歯車アイコンをクリックします。

  2. Add をクリックし、Environment Name (環境名) を入力します。

  3. 表に、datadog_api_key 変数と datadog_application_key 変数を追加します。Current Value 列に、実際の Datadog API キーとアプリケーションキーを入力します。

  4. datadog_site 変数を追加します。Current Value 列に、Datadog US サイトの場合は com、Datadog EU サイトの場合は eu と入力します。

  5. オプション: Datadog オーガニゼーションが複数ある場合は、オーガニゼーションごとに手順 1 から 4 を繰り返します。

コレクションの使用

セットアップが完了したら、いつでも API 呼び出しを行うことができます。Postman -> Datadog フォルダーには、Datadog API リファレンスに一覧表示されている各 API カテゴリタイプのサブフォルダーがあります。このサブフォルダーを展開すると、HTTP メソッドと API 呼び出し名を確認できます。

: 必ず Postman インターフェイスの右上隅で定義済み環境を設定してください。

ビルダー

コレクション内の API 呼び出しをクリックすると、右側の Builder ペインにロードされます。このペインで API 呼び出しを送信し、返されたステータス、応答時間、および API 応答コードを確認できます。

説明

エンドポイント名をクリックすると、エンドポイントの説明と、すべての必須/オプションパラメーターが表示されるため、容易にリクエストを構築できます。

Params

Params タブには、現在 API 呼び出しに存在するすべてのパラメーターと値が表示されます。ここでは、パラメーターと値を追加できます。使用可能な引数は、Datadog API ドキュメント の対応するセクションで確認してください。

このタブは、API 呼び出しの param1:value1¶m2:value2 構造を表示する代わりに使用できます。

:

  • params テーブルでは、アンパサンド (&) とコロン (:) は不要です。Postman によって挿入されます。
  • すべてのプレースホルダーは <PLACEHOLDER> の形式に従います。プレースホルダーはクエリを実行する前に置き換える必要があります。