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

ステップ 1：ユーザープロファイル API を作成する

この例では、DataService Studio の API 機能を使用して操作が実行されます。

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

2. API を作成します。

   DataService Studio ページの [サービス開発] ウィンドウで、 アイコンをクリックし、[ API を作成] > [ API を生成] を選択します。[ API を生成] ダイアログボックスで、[コードレス UI ] を使用して API を作成するためのパラメータを構成します。

   説明

   API は、[コードレス UI] または [コードエディター] を使用して作成できます。この例では、[コードレス UI] を使用して API を作成します。

   • コードレス UI を使用して API を作成する方法については、「コードレス UI を使用して API を作成する」をご参照ください。

   • コードエディタを使用して API を作成する方法については、「コードエディタを使用して API を作成する」をご参照ください。

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

1. ユーザープロファイル API の詳細を構成します。

   コードレス UI を使用してユーザープロファイル API を作成した後、次の表に示すパラメータを構成して、API に関する詳細を構成できます。この例では、StarRocks データソースを使用するユーザープロファイル API が構成されています。コードレス UI を使用して API を作成する方法については、「コードレス UI を使用して API を作成する」をご参照ください。

   セクション	パラメータ	説明	例
   [テーブルを選択]	[データソースの種類]	データソースの種類。 説明 API ベースのデータサービスは、Hive データソースをサポートしていません。[データソースの種類] パラメータを構成するときに、サポートされているデータソースの種類を表示できます。	この例では、StarRocks が選択されています。
   	[データソース名]	追加されるデータソース。	この例では、ビジネスデータソース Doc_StarRocks_Storage_Compute_Tightly_01 が使用されます。
   	[データソース環境]	[本番] [開発]	この例では、[本番] が選択されています。
   	[テーブル名]	API で使用する必要があるテーブル。	この例では、テーブル ads_user_info_1d_StarRocks が選択されています。
   [パラメータを選択]	[戻り値のページネーション]	返される結果をページ分割するかどうかを指定します。このパラメータの設定は、リクエストパラメータとレスポンスパラメータの構成に影響します。 [戻り値のページネーション] をオンにした場合は、右側のナビゲーションウィンドウで [リソースグループ] をクリックし、指定したリソースグループの種類に基づいて [リソースグループ] タブの [1 回のリクエストあたりのデータレコードの最大数] パラメータを構成します。詳細については、「API を構成する」をご参照ください。	この例では、[戻り値のページネーション] はオフになっています。
   	[リクエストパラメータとして設定]	リクエストパラメータとして指定するフィールド。複数のフィールドをリクエストパラメータとして指定できます。	この例では、パーティションフィールド dt が [リクエストパラメータ] として指定されています。
   	[レスポンスパラメータとして設定]	レスポンスパラメータとして指定するフィールド。複数のフィールドをレスポンスパラメータとして指定できます。	この例では、テーブル ads_user_info_1d_StarRocks のすべてのフィールドが [レスポンスパラメータ] として指定されています。
   [ソートフィールド]	[ソートフィールド] セクションの構成はオプションです。API が返すデータを特定のフィールドに基づいてソートする場合は、フィールドを見つけて、[フィールドソートに追加] 列の [追加] をクリックします。[追加] をクリックすると、フィールドが [ソートフィールド] セクションに追加されます。		この例では、API が返すデータをソートするためにフィールドは追加されていません。

2. DataService Studio のリソースグループを構成します。

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

   セクション	パラメータ	説明
   [リソースグループの種類]	[スキーム]	[ DataService Studio 専用のリソースグループ] を選択します。
   	[ DataService Studio 専用のリソースグループ]	DataService Studio 専用のリソースグループまたはサーバーレスリソースグループ (推奨) を選択します。 重要 DataService Studio 専用のリソースグループを購入済みの場合は、それを直接選択できます。 使用可能なリソースグループがない場合は、サーバーレスリソースグループを購入することをお勧めします。詳細については、「サーバーレスリソースグループを作成して使用する」をご参照ください。 購入したサーバーレスリソースグループが選択不可になっている場合は、[ DataService Studio ] のリソースグループにコンピュートユニット ( CU ) クォータを構成する必要があります。詳細については、「クォータを管理する」をご参照ください。
   [環境設定]	[関数タイムアウト]	値を 30000 に設定します。単位：ミリ秒。
   	[1 回のリクエストあたりのデータレコードの最大数]	値を 2000 に設定します。

ステップ 3：API をテストして公開する

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

   1. 構成が完了したら、上部のツールバーの アイコンをクリックして API を保存し、上部のツールバーの アイコンをクリックして [ API をテスト] ダイアログボックスに移動します。

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

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

2. API を API Gateway に公開します。API が API Gateway に公開されると、オンライン呼び出しアドレスが生成されます。次の操作を実行して、API を API Gateway に公開できます。詳細については、「API を公開する」をご参照ください。

   1. API のテストが成功したら、API の構成タブの上部のツールバーにある アイコンをクリックして API を送信します。API が送信されると、API のバージョンが生成されます。API 用に生成されたすべてのバージョンの情報を表示するには、右側のナビゲーションウィンドウで [バージョン] をクリックします。

   2. バージョンの [アクション] 列の [公開] をクリックして、このバージョンの API を公開します。

   3. このバージョンの API が公開されたら、バージョンの [アクション] 列の [サービス管理] をクリックして API を管理します。または、上部のナビゲーションバーで [サービス管理] をクリックし、[ API の管理] ページの [公開済み API ] タブで API を管理します。詳細については、「API を管理および保守する」ディレクトリのトピックをご参照ください。