DataWorks:API データサービス

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

この例では、DataService Studio の API 機能を使用します。

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

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

   DataService Studio で、 アイコンをクリックし、Create API > Generate API を選択します。Generate API ダイアログボックスで、Wizard Mode を選択します。

   説明

   DataService Studio には、API を生成するための 2 つの方法、コードレス UI とコードエディターがあります。この例では、コードレス UI を使用します。

   • コードレス UI を使用した API の生成に関する詳細については、「データソースから API を生成する (API ゲートウェイ)」をご参照ください。

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

ステップ 2：ユーザープロファイル API の構成

1. API の詳細を構成します。

   コードレス UI で、StarRocks データソース API の以下のパラメーターを構成します。詳細については、「データソースから API を生成する (API ゲートウェイ)」をご参照ください。

   モジュール	パラメーター	説明	例
   [Table]	[Data Source Type]	データソースのタイプ。 説明 DataService Studio の API は Hive データソースをサポートしていません。サポートされているタイプはドロップダウンリストに表示されます。	このトピックでは、StarRocks データソースを例として使用します。
   	[Data Source Name]	作成したデータソース。	ビジネスデータソース Doc_StarRocks_Storage_Compute_Tightly_01 を使用します。
   	[Data Source Environment]	[Production Environment] [Development Environment]	Production Environment を選択します。
   	[Data Table Name]	API が使用するテーブル。	ads_user_info_1d_StarRocks テーブルを選択します。
   [Select Parameters]	[Pagination for Return Results]	ページネーションを有効にするかどうかによって、API のリクエストパラメーターとレスポンスパラメーターの設定方法が異なります。 右側のナビゲーションウィンドウの [リソースグループ] セクションで、リソースグループタイプに基づいて1 リクエストあたりの最大データレコード数を設定できます。詳細については、「データソースから API を生成する (API ゲートウェイ)」をご参照ください。	[Pagination for Return Results] は無効になっています。
   	[Set as Req Param]	リクエストパラメーターとして使用するテーブルフィールド。	パーティションフィールド dt を [Request Parameters] として設定します。
   	[Set as Resp Param]	レスポンスパラメーターとして使用するテーブルフィールド。	ads_user_info_1d_StarRocks テーブルのすべてのフィールドを [Response Parameters] として設定します。
   [Sorting Fields]	このパラメーターはオプションです。フィールドでソートする場合は、まず [パラメーターの選択] リストでフィールドを選択します。		ソートしません。

2. サービスのリソースグループを構成します

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

   モジュール	パラメーター	説明
   [リソースグループタイプ]	[Scheme]	[Exclusive Resource Group for DataService Studio]。
   	[Exclusive Resource Group for DataService Studio]	サーバーレスリソースグループ (推奨) または DataService Studio 専用リソースグループを選択できます。 重要 DataService Studio 専用リソースグループを購入済みの場合は、直接使用できます。 利用可能なリソースグループがない場合は、汎用サーバーレスリソースグループを購入することを推奨します。詳細については、「サーバーレスリソースグループの使用」をご参照ください。 リソースグループの構成時に、新しく購入したサーバーレスリソースグループが淡色表示されて選択できない場合は、リソースグループの データサービス の用途にクォータを割り当てます。詳細については、「タスクへの CU クォータの割り当て」をご参照ください。
   [環境構成]	[タイムアウト]	関数のタイムアウト期間 (ミリ秒単位)。例：30,000。
   	[Maximum Number of Data Records for a Single Request]	1 回のリクエストで返されるレコードの最大数。例：2,000。

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

1. API をテストして、レスポンスが正しいことを確認します。詳細については、「API のテスト」をご参照ください。

   1. 構成が完了したら、 [保存] アイコン をクリックし、次に [テスト] アイコン をクリックして API テストページに移動します。

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

   3. Start Test をクリックして API をテストします。たとえば、パラメーター名を dt、パラメータータイプを STRING、パラメーターの場所を QUERY、値を 20240522 に設定します。[成功レスポンスを例として自動保存] を選択し、[テスト] をクリックします。テストが成功すると、[リクエスト詳細] セクションに実行された SQL ステートメントとログが表示されます。レスポンスでは、errCode が 0、errMsg が 'success' となって成功が示され、data フィールドにクエリ結果が表示されます。

2. API の公開とは、API を API ゲートウェイにリリースしてパブリックエンドポイントを生成することです。詳細については、「API のテスト、公開、バージョン管理」をご参照ください。

   1. API がテストに合格したら、API 編集ページで [送信] アイコン をクリックします。この操作により、新しい API バージョンが生成されます。右側の Version タブをクリックして、バージョン管理パネルを開きます。バージョンリストで、ステータスが 公開可能 の対象バージョン (v1 など) を見つけます。

   2. Publish をクリックします。

   3. API が公開された後、Service Management ページで管理できます。このページにアクセスするには、バージョン管理パネルで Service Management をクリックするか、Service Management > [API の管理] > [公開済み API] に移動します。詳細については、「API の管理とメンテナンス」をご参照ください。