API Explorer の使用

このガイドでは、API Explorer を使用して Monitoring API メソッドを試す方法について説明します。API Explorer は、メソッドの REST API リファレンス ページに接続されたウィジェットです。[この API を試す] というタイトルのパネルとして表示されます。次のスクリーンショットは、1 つのパラメータ(name)があるメソッドに対して表示されるパネルを示しています。

API Explorer ウィジェット。

API Explorer を使用すると、コードを記述することなく Monitoring API でメソッドを試すことができます。ウィジェットには、各メソッドのパラメータを示すフォームが表示されます。フォームに入力し、[実行] ボタンをクリックして結果を確認します。

パネルの上部にあるボタンをクリックしてウィジェットを非表示にしたり、ボタンをクリックして全画面表示にしたりできます。

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

ドキュメントには、次のような [試してみる] ボタンが、いくつかのサンプルとともに記載されています。

試してみる

ボタンをクリックすると、API Explorer が適切なリファレンス ページに表示され、サンプルに応じてフィールドに値が入力されます。[PROJECT_ID] の値など、プロジェクトに合わせてフィールドを編集する必要があります。

エラーの回避と修正の詳細については、ヒントをご覧ください。

API Explorer へのアクセス

API Explorer は、各 REST API メソッドのリファレンス ページに添付されています。ウィジェットを見つけるには、メソッドのリファレンス ページ(monitoring.projects.metricDescriptors.list のリファレンス ページなど)に移動します。

最小限のリクエストの実行

ほとんどのメソッドには、必須のパラメータとオプションのパラメータがあります。必須のパラメータは、入力されるまで赤色のバーでマークされています。必須の引数のみを指定することで、最小限のリクエストを実行できます。

metricDescriptors.list メソッドは、プロジェクトで使用可能なすべての指標のタイプの記述子を返します。唯一の必須フィールドは 名前フィールドです。プロジェクトのこのリストを取得するには、フォーム projects/[PROJECT_ID] を使用して名前のプロジェクトの名前を指定します。

下のボタンをクリックして試してみてください。ただし、フォームの [実行] ボタンをクリックする前に、[PROJECT_ID] をプロジェクトの識別子に変更する必要があります。

試してみる

メソッドの呼び出しの結果が [実行] ボタンの下のボックスに表示されます。通常、ボックスには緑色のヘッダーがあり、リクエストが成功したことを示す HTTP ステータス コード 200 が表示されます。呼び出しの結果はボックスに表示されます。

メソッドの呼び出しの成功の結果。

ヘッダーが赤色で、HTTP エラーコードが含まれている場合は、ボックスにエラー メッセージが含まれています。エラーを解決するためのポイントについては、ヒントをご覧ください。

追加のパラメータの指定

表示されるパラメータのリストは、API Explorer ウィジェットが接続されているメソッドによって異なります。metricDescriptors.list メソッドには name パラメータ以外のパラメータもありますが、name のみが必須パラメータです。

プロジェクト名のみを指定すると、プロジェクトで使用可能なすべての指標記述子が取得されます。指標記述子は数多くあります。オプションの フィルタ パラメータを使用すると、取得対象をより小さなセットに制限できます。

たとえば、metricsDescriptor.list ページの次のフィールドに入力します。 プロジェクト ID は [PROJECT_ID] に置き換えますが、それ以外の値は次のように指定します。

  • 名前: projects/[PROJECT_ID]
  • フィルタ: metric.type=ends_with("utilization")

このリクエストを実行すると、名前が utilization で終わる指標タイプの記述子のみが返されます。

試してみる

出力をさらに制限するためのフィールドの使用

デフォルトでは、API Explorer によって表示されるパラメータのセットは関連するメソッドのパラメータに対応しています。ただし、API Explorer ウィジェットには、メソッド自体からは利用できない追加のフィールドのセットもあります。

これらのパラメータは、[認証] セクションの上に表示される [標準パラメータを表示する] の切り替えボタンの下に隠されています。

[標準パラメータを表示する] の切り替えボタン。

この切り替えボタンをクリックすると、特別のウィジェット パラメータが表示されます。[標準パラメータを非表示にする] をクリックすると、非表示になります。

これらの標準パラメータの最も有用なパラメータは fields パラメータで、返される出力で表示したいフィールドを選択できます。これは、出力がボックスに表示される API Explorer パネルで非常に役立ちます。多くの場合、スクロールする出力はたくさんあります。

たとえば、utilization で終わる指標の記述子を一覧表示すると、多くの情報が返されます。目的が指標タイプの名前とその説明文だけである場合は、フィールド フィールドを使用してそれらのフィールドのみを指定できます。

違いを確認するには、metricsDescriptor.list ページの次のフィールドに入力します。 プロジェクト ID は [PROJECT_ID] に置き換えますが、それ以外の値は次のように指定します。

  • 名前(前述のとおり): projects/[PROJECT_ID]
  • フィルタ(前述のとおり): metric.type=ends_with("utilization")
  • フィールド: metricDescriptors.type,metricDescriptors.description

このリクエストを実行すると、各指標とその descriptiontype(短縮名)のみが返されます。以下は出力の一部です。

試してみる

ヒント

[PROJECT_ID] を忘れずに変更する

[PROJECT_ID] は、忘れずに実際のプロジェクト ID に置き換えてください。忘れると、次のような結果になります。

PROJECT_ID を変更し忘れた場合のエラー メッセージ。

値に関する問題

次は、API Explorer のフォームを使用する際に注意するいくつかの点です。これらのミスはエラーを発生させる可能性があるか、受け入れられても、API メソッドでスペルミスのように扱われます。

  • いかなるタイプのフィールド値も、それを囲む引用符を使用しないでください。
  • 内部のフィルタに現れる文字列は引用してください。アポストロフィ(')ではなく、二重引用符(")を使用します。例については、追加パラメータの指定をご覧ください。
  • フォーム フィールドにバックスラッシュまたは URL エンコードを使用しないでください。 必要な場合は、メソッドを実行すると、URL エンコードはフィールド値で実行されます。
  • 呼び出しを実行した後、結果ボックスの値を確認します。そこで問題に気づくかもしれません。
  • 2 など、pageSize フィールドの値を指定したい場合があります。これにより、API 呼び出しをデバッグすると返されるデータ量を制限します。

デバッグ用 URL をブックマークする

目的の出力が得られたら、API Explorer の URL をブックマークします。 メソッドを再度実行する場合は、ブラウザにその URL を貼り付けます。既にフォームに値が入力されているでしょう。 パラメータに必要な変更を加え、[実行] をクリックしてメソッドを再度実行します。

認証

API Explorer ページの [実行] ボタンの上に [認証] セクションがあります。通常、ここでは何も変更する必要はありません。

デフォルトの認証メカニズムは Google OAuth 2.0 です。

また、[認証] セクションには [スコープの表示] トグルもあります。これにより、利用可能な Compute Engine スコープが表示されます。デフォルトでは、使用可能なすべてのスコープが有効になっています。

これらのコンセプトの詳細については、アクセス制御をご覧ください。

トラブルシューティング

それでも問題が解決しない場合は、Monitoring API のトラブルシューティングをご覧ください。