すべてのプロダクト
Search

このプロダクト

    DataWorks:データサービス API

    ドキュメントセンター

    DataWorks:データサービス API

    最終更新日:Jun 22, 2026

    DataWorks の DataService Studio を使用すると、データを API として公開できます。このチュートリアルでは、データサービス API を作成して公開する方法をステップバイステップで説明します。

    前提条件

    ユーザープロファイル API の作成

    データを同期して処理すると、DataWorks によって ads_user_info_1d_${data_source_type} という名前のテーブルが生成されます。 DataWorks を使用して、このテーブルを API として他のサービスに公開できます。 DataService Studio では、API サービスを Wizard Mode または Script Mode のいずれかで生成できます。

    ステップ 1: API の生成

    1. DataWorks コンソールにログインします。対象のリージョンで、左側のナビゲーションウィンドウで データ分析とサービス > データサービス をクリックします。ドロップダウンリストからワークスペースを選択し、入力 データサービスします。

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

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

      説明

      API は、コードレス UI または コードエディタ で生成できます。このチュートリアルでは、コードレス UI を例として使用します。

    ステップ 2: API の設定

    1. API の詳細を設定します。

      コードレス UI で、次の表のパラメーターを設定して、API が StarRocks データソースを使用するように設定します。詳細については、「データソースからの API の作成 (API Gateway)」をご参照ください。

      モジュール

      パラメーター

      説明

      例

      Table

      Data Source Type

      データソースタイプを選択します。

      説明

      DataService Studio は 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 の作成 (API Gateway)」をご参照ください。

      Pagination for Return Results は無効のままにします。

      Set as Req Param

      リクエストパラメーターとして使用するテーブルフィールドを 1 つ以上選択します。

      dt パーティションフィールドを Request Parametersとして設定します。

      Set as Resp Param

      レスポンスで返却するテーブルフィールドを 1 つ以上選択します。

      ads_user_info_1d_StarRocks テーブルのすべてのフィールドをResponse Parametersとして設定します。

      Sorting Fields

      これはオプションです。フィールドでソートする場合は、まず [パラメーターの選択] リストでフィールドを選択します。

      ソートは設定しません。

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

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

      モジュール

      パラメーター

      説明

      リソースグループタイプ

      Scheme

      Exclusive Resource Group for DataService Studio。

      Exclusive Resource Group for DataService Studio

      サーバーレスリソースグループ (推奨) または DataService Studio 専用リソースグループを選択できます。

      重要

      • DataService Studio 専用リソースグループを購入済みの場合は、直接使用できます。

      • 利用可能なリソースグループがない場合は、汎用のサーバーレスリソースグループを購入することを推奨します。詳細については、「サーバーレスリソースグループの使用」をご参照ください。

        新しいサーバーレスリソースグループが選択不可で表示され、リソースグループを設定する際に選択できない場合は、データサービス の目的でクォータを割り当ててください。詳細については、「タスクへの CU クォータの割り当て」をご参照ください。

      環境構成

      タイムアウト

      30,000 ms に設定します。

      Maximum Number of Data Records for a Single Request

      2,000 レコードに設定します。

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

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

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

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

      3. Start Test をクリックしてテストを実行します。たとえば、dt パラメーターの値を 20240522 に設定し、[テスト] をクリックします。テストが成功すると、右側の [リクエスト詳細] セクションに実行ログと SQL ステートメントが表示され、[レスポンス] セクションに JSON 形式の結果が表示されます。errCode が 0 で errMsg が success の場合、API 呼び出しが成功したことを示します。

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

      1. テストが成功したら、API 編集ページで送信アイコン image をクリックして新しいバージョンを生成します。次に、API 詳細ページで、右側のペインの Version タブをクリックしてバージョン管理パネルを開きます。バージョンのリストと、[公開可能] などのステータスを表示できます。

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

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

    次のステップ

    API が公開された後、アプリケーションに API の呼び出しを承認できます。詳細については、「API の承認」および「API の呼び出し」をご参照ください。