DataWorks:API を使用してデータサービスを提供する

ステップ 1: ユーザーペルソナ API の生成

この例では、DataService Studio の API 機能を使用するために必要な操作について説明します。

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

2. API サービスを作成します。

   DataService Studio ページで、 アイコンをクリックし、[新規 API] > [API の生成] を選択します。[API の生成] ダイアログボックスで、[Codeless UI] を選択して API を生成します。

   説明

   API は [Codeless UI] または [コードエディタ] モードで生成できます。このトピックでは、[Codeless UI] モードを例として使用します。

   • 詳細については、「コードレス UI で API を生成する」をご参照ください。

   • 詳細については、「コードエディタで API を生成する」をご参照ください。

ステップ 2: ユーザーペルソナ API の設定

1. 詳細を設定します。

   コードレス UI でユーザーペルソナ API を作成した後、パラメーターを設定して MaxCompute データソースの API データサービスを実装します。詳細については、「コードレス UI で API を生成する」をご参照ください。

   セクション	パラメーター	設定	例
   テーブルの選択	データソースタイプ	データソースタイプを選択します。 説明 API ベースのデータサービスは Hive データソースをサポートしていません。サポートされているデータソースタイプがドロップダウンリストに表示されます。	この例では、MaxCompute データソースを使用します。
   	データソース名	作成したデータソースを選択します。	ビジネスデータソースを使用します。
   	データソース環境	本番環境 開発環境	[本番環境] を選択します。
   	テーブル名	API で使用するテーブルを選択します。	ads_user_info_1d テーブルを選択します。
   パラメーターの選択	返却結果のページング	返される結果のページングを有効にするかどうかを指定します。この設定は、API のリクエストパラメーターとレスポンスパラメーターに影響します。 右側のナビゲーションウィンドウのサービスリソースグループ設定で、リソースグループタイプに基づいて 1 回のリクエストの最大データレコード数を設定できます。詳細については、「API の設定」をご参照ください。	[返却結果のページング] をオフにします。
   	リクエストパラメーターとして設定	テーブル内の 1 つ以上のフィールドをリクエストパラメーターとして設定します。	dt パーティションフィールドを [リクエストパラメーター] として設定します。
   	レスポンスパラメーターとして設定	テーブル内の 1 つ以上のフィールドをレスポンスパラメーターとして設定します。	ads_user_info_1d テーブルのすべてのフィールドを [レスポンスパラメーター] として設定します。
   ソートフィールド	このパラメーターはオプションです。フィールドで結果をソートするには、まずパラメーターリストからフィールドを選択します。		ソートは設定されていません。

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

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

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

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

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

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

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

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

2. API を API Gateway に公開して、オンラインエンドポイントを生成します。詳細については、「API の公開」をご参照ください。

   1. API がテストに合格したら、API 編集ページで アイコンをクリックして API を送信します。新しい API バージョンが生成されます。ページの右側にある [バージョン] をクリックして、送信された API バージョンに関する情報を表示できます。

   2. [公開] をクリックして API サービスを公開します。

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