API Explorer を使用する

このガイドでは、Monitoring API メソッドを試すために API Explorer の使用方法について説明します。

API Explorer は、Monitoring API を試すための優れた方法です。Explorer では、各メソッドのパラメータを示すフォームが表示されます。フォームに入力し、API 呼び出しを実行して結果を参照してください。以下のボタンをクリックして、API Explorer をご覧ください。

試してみましょう

API Explorer の承認

API Explorer のフォームの上部は次のようになります。

[Authorize requests using OAuth 2.0] をオンにします。下に、[Select OAuth 2.0 scopes] のフォームが表示されます。

リスト内のすべてのスコープを選択し、[Authorize] をクリックします。Monitoring API 用の元の APIs Explorer フォームと API メソッドの一覧が表示されます。

メソッドを選択する

呼び出すメソッドを選択します。そこで、次の [monitoring.projects.metricDescriptors.list] をクリックします。

パラメータを入力する

次のような metricDescriptors.list メソッドフォームが表示されます。

フォーム上で、次の項目に入力します。プロジェクト ID を {your-project-id} に置き換え、他のすべてのフィールドは変更せずにコピーします。

名前: projects/{your-project-id}
フィルタ: metric.type=ends_with("utilization")
フィールド: metricDescriptors.type,metricDescriptors.description

注: これらのフィールドは文字列値を保持しますが、値の前後に引用符を入れてはいけません。フィルタのように値が内部に文字列を持っている場合は、内側の文字列の周りに二重引用符を使用します。

メソッドを実行する

[実行] ボタンをクリックします。次のサンプル応答では、フィルタに一致する 3 つの指標の説明が見えます。

上のような出力が示されない場合は、上記のように情報を入力したか確認してください。フォーム内で変更を行い、再度 [実行] をクリックします（2 回 [実行] をクリックする必要がある場合があります）。それでも問題がある場合は、API 呼び出しのトラブルシューティングを参照してください。

自由に API メソッドとフォームを探索してください。

ヒント: 必要な出力を取得した後、API Explorer の URL をブックマークします。再びメソッドを実行したい場合は、ブラウザにこの URL を貼り付けます。既にフォームに値が入力されているでしょう。必要な変更をした後、Explorer の再認証を行い、メソッドを実行するために [実行] をクリックします。

[試してみましょう] ボタン

入門セクションでは、次のような [試してみましょう] ボタンが表示されます。

試してみましょう

ボタンをクリックすると、適切なメソッドで API Explorer が起動します。フィールドに値を入力してください。実際のプロジェクトに合わせて、{your-project-id} の値などのようにいくつかのフィールドを編集する必要があります。

トラブルが発生した場合は、API Explorer 形式でプロジェクト ID を変更することを忘れないでください。それでも問題が解決しない場合は、API 呼び出しのトラブルシューティングを参照してください。