DataWorks:データサービス API

ステップ 1: ユーザープロファイル API の生成

DataService Studio で、以下の手順を実行します。

1. DataWorks コンソールにログインします。 左側のナビゲーションウィンドウで、[DataService Studio] をクリックします。 表示されるページで、ドロップダウンリストから目的のワークスペースを選択し、[DataService Studioに移動] をクリックします。

2. API を作成します。

   DataService Studio ページで、 アイコンをクリックし、APIの作成 > APIの生成 を選択します。APIの生成 ダイアログボックスで、コードレス UI を選択します。

   説明

   API は ウィザードモード または スクリプトモード で生成できます。この例では ウィザードモード を使用します。

   • ウィザードモードで API を生成する方法の詳細については、「データソースから API を生成 (API ゲートウェイ)」をご参照ください。

   • スクリプトモードで API を生成する方法の詳細については、「スクリプトモードで API を生成」をご参照ください。

ステップ 2: ユーザープロファイル API の設定

1. API を設定します。

   ウィザードモードで、以下のパラメーターを設定して、MaxCompute データソース用のデータサービス API を作成します。詳細については、「データソースから API を生成 (API ゲートウェイ)」をご参照ください。

   モジュール	パラメーター	説明	例
   [テーブルの選択]	[データソースの種類]	データソースタイプを選択します。 説明 データサービス API は Hive データソースをサポートしていません。使用可能なデータソースタイプは、ドロップダウンリストに表示されるオプションに限られます。	この例では、MaxCompute データソースを使用します。
   	[データソース名]	既存のデータソースを選択します。	ビジネスデータソースを使用します。
   	[データソース環境]	[本番環境] [開発環境]	[本番環境] を選択します。
   	[データテーブル名]	API のテーブルを選択します。	ads_user_info_1d テーブルを選択します。
   [パラメーターの選択]	[結果のページング]	結果のページネーションを有効または無効にします。この設定は、API のリクエストパラメーターとレスポンスパラメーターに影響します。 右側のサービスリソースグループパネルで、リソースグループタイプに基づいて、リクエスト1回あたりの最大レコード数を設定できます。詳細については、「データソースから API を生成 (API ゲートウェイ)」をご参照ください。	[結果のページング] を無効にします。
   	[リクエストパラメーターに設定]	リクエストパラメーターとして使用するフィールドを選択します。	dt パーティションフィールドを [リクエストパラメーター]として設定します。
   	[戻りパラメーターに設定]	レスポンスパラメーターとして使用するフィールドを選択します。	ads_user_info_1d テーブルのすべてのフィールドを [戻りパラメーター]として設定します。
   [ソートフィールド]	並べ替えフィールドはオプションです。フィールドで並べ替える場合は、まずパラメーターのリストから目的のフィールドを選択します。		並べ替えは行いません。

2. サービスリソースグループの設定

   API の設定後、右側のナビゲーションペインで サービスリソースグループ をクリックして、そのリソースを設定します。パラメーターを次の表に示します。詳細については、「API のサービスリソースグループの設定」をご参照ください。

   モジュール	パラメーター	説明
   [リソースグループのタイプ]	[ソリューション]	[データサービススタジオ専用リソースグループ]
   	[データサービススタジオ専用リソースグループ]	サーバーレスリソースグループ (推奨) または DataService Studio 専用リソースグループを選択します。 重要 DataService Studio 専用リソースグループを購入済みの場合は、直接使用できます。 リソースグループがない場合は、汎用のサーバーレスリソースグループを購入することを推奨します。詳細については、「サーバーレスリソースグループの使用」をご参照ください。 サービスリソースグループを設定する際に、新しく購入したサーバーレスリソースグループがグレー表示されて選択できない場合は、リソースグループの DataService Studio の使用量にクォータを割り当てる必要があります。詳細については、「タスクへの CU クォータの割り当て」をご参照ください。
   [環境構成]	[タイムアウト時間]	値を 30000 ms に設定します。
   	[ページングサイズ]	値を 2000 に設定します。

ステップ 3: API のテストと公開

1. API をテストして、期待どおりのレスポンスパラメーターが返されることを確認します。詳細については、「API のテスト」をご参照ください。

   1. 設定が完了したら、 アイコンをクリックして API を保存し、次に アイコンをクリックしてテストページを開きます。

   2. [API test] ダイアログボックスで、リクエストパラメーターの値を入力します。

   3. テストの開始 をクリックして API テストを開始します。

2. API を公開すると、API は API ゲートウェイに追加され、オンラインエンドポイントが生成されます。詳細については、「API のテスト、公開、バージョン管理」をご参照ください。

   1. API がテストに合格したら、API 編集ページで アイコンをクリックして API を送信します。新しい API バージョンが生成されます。API 詳細ページの右側のパネルで、バージョン タブをクリックしてバージョン管理ページに移動します。[Publishable] ステータスのバージョン (v1 など) を見つけます。

   2. 発行 をクリックして API を公開します。

   3. API が公開されたら、バージョン管理セクションで サービス管理 をクリックするか、サービス管理 > [API Management] > [Published APIs] に移動します。詳細については、「API の管理とメンテナンス」をご参照ください。