API Explorer の使用

このページでは、API Explorer を使用して Dataproc Metastore API メソッドを試す方法について説明します。API Explorer は、メソッドの REST API リファレンス ページにアタッチされたウィジェットです。[この API を試す] というタイトルのパネルとして表示されます。

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

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

始める前に

  • Google Cloud アカウントにログインします。Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。
  • Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

    プロジェクト セレクタに移動

  • Dataproc Metastore API を有効にします。

    API を有効にする

API Explorer へのアクセス

API Explorer は、各 REST API メソッドのリファレンス ページに添付されています。ウィジェットを見つけるには、メソッドのリファレンス ページ(Dataproc Metastore projects.locations.services.create のリファレンス ページなど)をご覧ください。

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

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

services.create メソッドによって、選択したプロジェクトとロケーションに Dataproc Metastore サービスが作成されます。必須項目は、 項目と serviceId 項目です。サービスを作成するには、projects/{projectNumber}/locations/{locationId} のフォームを使用して、のプロジェクトのプロジェクト番号とロケーション ID を指定します。serviceId のサービス ID を指定します。

試してみる

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

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

追加のパラメータの指定

表示されるパラメータのリストは、API Explorer ウィジェットが接続されているメソッドによって異なります。services.create メソッドには、parent パラメータと serviceId パラメータ以外にもパラメータがありますが、必須のパラメータはこれだけです。

オプションの requestId パラメータを使用して一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。

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

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

これらのパラメータは、切り替えボタンの [Show standard parameters] の下に隠れており表示されません。

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

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

ヒント

以降のセクションでは、API Explorer の使用方法について説明します。

{projectNumber} and {locationId} を忘れずに変更する

{projectNumber} and {locationId} は、必ずプロジェクト番号とロケーション ID に置き換えてください。API には、プロジェクト番号の代わりにプロジェクト ID も使用できます。

値に関する問題

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

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

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

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

認証

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

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

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

次のステップ