すべてのプロダクト
Search

このプロダクト

    DataWorks:API を使用したデータサービスの提供

    ドキュメントセンター

    DataWorks:API を使用したデータサービスの提供

    最終更新日:Apr 21, 2026

    DataWorks の DataService Studio を使用すると、処理済みのデータテーブルを REST API として公開し、他のビジネスアプリケーションとデータを共有できます。このチュートリアルでは、ユーザープロファイルテーブル ads_user_info_1d のデータを提供する API を作成、設定、テスト、公開する方法を説明します。

    前提条件

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

    データを同期して処理すると、ads_user_info_1d という名前のデータテーブルが生成されます。API を使用してデータを受信できる他のサービスにこのテーブルを提供するには、DataWorks の DataService Studio の API 機能を使用して、Wizard ModeまたはScript Modeで API サービスを生成できます。

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

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

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

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

      説明

      DataService Studio は、API を生成するための2つのモード、ウィザードモードとスクリプトモードをサポートしています。

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

    1. API を設定します。

      ウィザードモードで、次のパラメーターを設定して、MaxCompute データソース用の API を作成します。詳細については、データソースから API を生成する (API Gateway) をご参照ください。

      セクション

      パラメーター

      説明

      例

      Table

      Data Source Type

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

      説明

      DataService Studio は Hive データソースをサポートしていません。利用可能なタイプはドロップダウンメニューに表示されます。

      このチュートリアルでは MaxCompute データソースを使用します。

      Data Source Name

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

      ビジネスデータソースを選択します。

      Data Source Environment

      • Production Environment

      • Development Environment

      Production Environmentを選択します。

      Data Table Name

      API を通じて公開したいテーブルを選択します。

      ads_user_info_1d テーブルを選択します。

      Select Parameters

      Pagination for Return Results

      結果をページ分割するかどうかを指定します。この設定はリクエストパラメーターとレスポンスパラメーターに影響します。

      サービスリソースグループの設定で、1回のリクエストあたりの最大データレコード数を設定できます。詳細については、データソースから API を生成する (API Gateway) をご参照ください。

      Pagination for Return Resultsをオフにします。

      Set as Req Param

      テーブル内の1つ以上のフィールドをリクエストパラメーターとして設定します。

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

      Set as Resp Param

      API レスポンスに含めるテーブルフィールドを選択します。

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

      Sorting Fields

      このパラメーターはオプションです。結果をソートする必要がある場合は、まずパラメーターリストで目的のフィールドを選択します。

      ソートしません。

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

      ウィザードモードで API を設定した後、右側のナビゲーションウィンドウで Resource Group for DataService Studio をクリックしてリソースグループを設定します。詳細については、API サービスリソースグループの設定をご参照ください。

      セクション

      パラメーター

      説明

      リソースグループタイプ

      Scheme

      Exclusive Resource Group for DataService Studio。

      Exclusive Resource Group for DataService Studio

      サーバーレスリソースグループ (推奨) またはデータサービススタジオ専用リソースグループを選択できます。

      重要

      • データサービススタジオ専用リソースグループを購入済みの場合は、直接使用できます。

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

        新しく購入したサーバーレスリソースグループがグレーアウトして選択できない場合は、まずこのリソースグループにデータサービスサービスのクォータを割り当てる必要があります。詳細については、タスクへの CU クォータの割り当てをご参照ください。

      環境構成

      タイムアウト

      タイムアウトを 30,000 ms に設定します。

      Maximum Number of Data Records for a Single Request

      上限を 2,000 に設定します。

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

    1. API をテストして、正しいパラメーターが返されることを確認します。詳細については、API のテストをご参照ください。

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

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

      3. Start Testをクリックしてテストを実行します。

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

      1. API がテストに合格したら、API 編集ページに戻り、image 送信アイコンをクリックします。これにより、新しい API バージョンが作成されます。右側のパネルでVersionをクリックして詳細を表示します。image

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

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

    次のステップ

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