このトピックでは、リアルタイムデータウェアハウスである Hologres を DataWorks データサービスに接続し、API を生成する方法について説明します。
前提条件
DataWorks がアクティブ化されていること。詳細については、「概要」をご参照ください。
Hologres インスタンスが購入され、DataWorks ワークスペースに関連付けられていること。
背景情報
DataWorks DataService Studio は、統一されたデータサービスバスを構築し、API を管理するために設計されています。テーブルから API を作成したり、既存の API を DataService Studio に登録したりできます。これにより、API を一元的に管理および公開できます。
Hologres は DataWorks と緊密に統合されており、DataService Studio に直接接続します。データクエリ結果に基づいて API を迅速に作成し、その API を使用してサービスを提供できます。
操作手順
DataWorks コンソールにログインし、Hologres データソースを追加します。詳細については、「Hologres コンピューティングリソースの関連付け」をご参照ください。
-
API を作成します。
-
DataWorks の開発ページで、上部メニューバーの左側にある
アイコンをクリックします。 -
[すべてのプロダクト] にカーソルを合わせ、[Data Service > Data Service] をクリックします。
-
[Service Development] ページで、
アイコンにカーソルを合わせます。 -
[Create API > Generate API] にカーソルを合わせます。[Codeless UI] または [Code Editor] のいずれかで API を生成できます。
[Codeless UI] で API を生成する場合は、「API Gateway を使用してデータソースから API を生成する」をご参照ください。
[Code Editor] で API を生成する場合は、「スクリプトモードで API を生成する」をご参照ください。
-
-
API をテストします。
-
API 編集ページで、右上隅の [Test] をクリックします。
-
[APIテスト] ダイアログボックスで、[リクエストパラメーター] を入力し、[Start Dry Run] をクリックします。テストが完了すると、Response エリアに、
errCodeが0で、errMsgがsuccessの JSON レスポンスが表示されます。下部には、緑色の Test Succeeded メッセージと API 呼び出しのレイテンシーが表示されます。[Success] ダイアログボックスの下部に [APIテスト] と表示されれば、API テストは成功です。
DataService Studio の Test APIs モジュールで API をテストすることもできます。詳細については、「API のテスト」をご参照ください。
-
-
API を公開し、詳細を表示します。
-
API 編集ページで、右上隅の [公開] をクリックします。
API を API Gateway に公開して、API マーケットプレイスで利用できるようにします。詳細については、「API テスト、公開、およびバージョン管理」をご参照ください。
-
[DataService Studio] ページで、右上隅の [Service Management] をクリックします。
公開された API を見つけ、API 名をクリックして詳細を表示します。
-
API を呼び出します。
公開された API を呼び出す方法の詳細については、「API 呼び出しの例」をご参照ください。