Datadog API と Postman の使用

概要

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

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

前提条件

以下が必要です。

セットアップ

Postman に Datadog コレクションをインポート

Postman へのログインから始めます。Datadog は Postman アプリケーションをダウンロードすることをお勧めします。



このコレクションは Web 用 Postman またはお使いの Postman アプリケーションで動作します。読み込みに数秒かかることがあります。

注: Datadog Postman コレクションの Datadog 認証環境を、API キーとアプリケーションキーで構成します。

Postman 環境のセットアップ

Postman コレクションをインポートすると、Postman の左ペインに、使用できるすべての Datadog API 呼び出しの一覧がフォルダーごとに構造化されて表示されます。

Go

コレクションには、Postman 環境である Datadog Authentication が含まれます。ここに Datadog API キーと認証用のアプリケーションキーを追加できます。

API フィールドと Application Key フィールドが入力された Datadog Authentication コレクション

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

  1. Postman の右上隅にある Environments ドロップダウンをクリックします。現時点で環境が選択されていない場合は、Environments ドロップダウンに No Environment と表示されます。

  2. Datadog Authentication を選択します。

  3. Datadog Authentication 環境を編集して Datadog API キーを api_key 変数の初期値および現在値として追加し、お使いの Datadog アプリケーションキーを application_key 変数の初期値および現在値として追加します。

  4. Save をクリックします。

API エンドポイントに切り替える

https://api.datadoghq.com 以外の Datadog サイトにアクセスしている場合、別のエンドポイント URL にアクセスするには Postman コレクションに切り替える必要があります。

選択したサイト () へのインスタンスを更新するには、以下の手順に従います。

  1. 左ペインの Datadog API コレクションフォルダーで、メニュー (3 点リーダー) をクリックし、Edit を選択します。

    他のアクションを表示

  2. Variables タブで、datadoghq.com の値を持つ site 変数の選択を解除し、 の値を持つ site を選択します。

  3. Update をクリックします。

コレクションの使用

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

ビルダー

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

Postman API の応答

説明

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

Params

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

Postman のパラメーター

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

注:

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