DataWorks:はじめに

API 開発

データプッシュ

DataWorks の DataService Studio は、データコンテンツをターゲットグループにスケジュール通りにプッシュするデータプッシュ機能をサポートしています。データプッシュタスクを使用して、さまざまなデータソースからのリッチテキストやテーブルなどのプッシュコンテンツを編成できます。ビジネスニーズに基づいて定期的なプッシュ頻度を設定し、さまざまなデータコンシューマー向けのプッシュオブジェクトとチャネルを指定できます。これにより、データ配信の効率を向上させ、データ消費シナリオを拡大できます。詳細については、「データプッシュ」をご参照ください。

ステップ 1：データソースの作成とネットワーク接続の設定

DataService Studio で API を作成する前に、データベースまたはデータウェアハウスを DataWorks データソースとして追加する必要があります。また、DataService Studio リソースグループが宛先データソースに接続できることを確認し、API 呼び出し中に DataWorks がデータソースにアクセスできるようにする必要があります。

API 開発中、DataService Studio はこのデータソースにアクセスしてデータテーブルのスキーマ情報を取得します。これにより、リクエストパラメーターとレスポンスパラメーターを設定できます。API が呼び出されると、DataService Studio はデータソースにアクセスしてクエリを実行します。サポートされているデータソースのリストについては、「DataService Studio のデータソースリスト」をご参照ください。

このトピックでは、rds_workshop_log という名前の MySQL データソースを例として使用し、DataService Studio の公共リソースグループとの接続性をテストする方法について説明します。

1. DataWorks 管理センターに移動し、目的のワークスペースを選択して入力 管理センター をクリックします。

2. 左側のナビゲーションウィンドウで [データソース] をクリックして、データソース管理ページを開きます。

3. データソースを作成し、そのネットワーク接続をテストします。

   1. [データソースを追加] をクリックし、データソースタイプを選択します。

      このTopicでは、[MySQL]を例として使用します。

   2. データソース情報を設定します。

      ページ上のプロンプトに従ってパラメーターを設定します。詳細については、「MySQL データソースの設定」をご参照ください。

   3. サーバーレスリソースグループを選択し、リソースグループとデータソース間の接続性をテストします。

      説明

      • オフピーク時に実行できない高同時実行タスクがある場合は、専用リソースを使用して高同時実行かつ高頻度の API 呼び出しをサポートします。DataWorks から サーバーレスリソースグループを購入して使用することを推奨します。

      • サーバーレスリソースグループを使用する場合、サーバーレスリソースグループで DataService Studio のクォータを設定する必要があります。

      • 接続性テストが失敗した場合は、設定を確認してください。詳細については、「ネットワーク接続とホワイトリスト」をご参照ください。

   4. [完了] をクリックしてデータソースを作成します。

ステップ 2：API グループの作成

DataService Studio は、API Gateway を通じて外部システムにサービスを提供します。API Gateway では、グループは API の管理単位であり、呼び出しアドレスのドメイン名に関連付けられています。したがって、DataService Studio で API を作成する前に、まず API Gateway で API グループを作成する必要があります。

1. API Gateway コンソールに移動します。[グループ管理] ページで、[グループの作成] をクリックします。

2. グループ情報を入力し、グループを作成します。このトピックでは、Workshop という名前のグループを例として使用します。

ステップ 3：ビジネスプロセスの作成

DataService Studio では、ビジネスプロセスを使用して、業務部門に基づいて API を開発し、API や関数などのファイルを整理および管理します。したがって、API を作成する前に、まずビジネスプロセスを作成する必要があります。

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

2. ビジネスプロセスを作成します。

   DataService Studio > サービス開発 ページで、次のいずれかの方法でビジネスプロセスを作成できます：

   • 方法 1： アイコンをクリックし、[ビジネスプロセスの作成] を選択します。

   • 方法 2：左側のナビゲーションウィンドウで、[ビジネスプロセス] フォルダを右クリックし、[ビジネスプロセスの作成] を選択します。

3. ビジネスプロセスのパラメーターを設定します。

   設定	説明
   ビジネス名	ビジネスシナリオに基づいてカスタム名を入力します。このトピックでは、DataService を例として使用します。
   API グループ	API を管理するための API グループを選択します。このトピックでは、ステップ 2 で作成した Workshop グループを使用します。 説明 API グループは、特定の機能またはシナリオのための API のコレクションです。また、API Gateway における API 管理の最小単位でもあります。新しいグループを作成するには、「ステップ 2：API グループの作成」をご参照ください。

4. [OK] をクリックしてビジネスプロセスを作成します。

   ビジネスプロセスが作成されると、DataService Studio ページの左側のナビゲーションウィンドウのフォルダでその詳細を表示できます。

ステップ 4：API の生成

ビジネスプロセスを作成した後、そのプロセス内で API を作成できます。

1. API を生成します。

   DataService Studio > サービス開発 ページで、次のいずれかの方法で API を生成できます：

   • 方法 1： アイコンをクリックし、[API の作成] > [API の生成] を選択します。

   • 方法 2：左側のナビゲーションウィンドウで、対象のビジネスプロセスを右クリックし、[新規] > [API] > [API の生成] を選択します。

2. API のプロパティを定義します。

   [API の生成] ダイアログボックスで、API 情報を設定します。次の図は設定例を示しています。次の表に、主なパラメーターを説明します。

   設定項目	説明
   宛先フォルダ	左側のビジネスプロセスで API が保存されるフォルダを定義します。テキストをクリックしてフォルダを選択します。 重要 最初に宛先フォルダを選択することを推奨します。フォルダを選択できない場合は、まず ビジネスプロセスを作成してください。
   API モード	API を作成するモードを選択します。コードレス UI またはコードエディタを選択できます。 コードレス UI：コードを記述せずにデータ API を迅速に設定します。 コードエディタ：テーブル結合、複雑なクエリ、集計関数などの高度な機能をサポートします。高度なクエリ要件を満たすために、API 用にカスタム SQL クエリを記述できます。 このトピックの例では、コードレス UI を使用します。2 つのパターンの詳細については、「API 生成の概要」をご参照ください。
   API 名	API のカスタム名を入力します。このトピックでは、rpt_user_info_all_d を例として使用します。
   API パス	API のストレージパスです。これは、サービスホストに対するリクエストの URI です。このパスは、API 呼び出しアドレスを構築するために使用されます。このトピックでは、/user を例として使用します。
   プロトコル	HTTP と HTTPS がサポートされています。 HTTPS 経由で API を呼び出すには、API をゲートウェイに公開した後、API Gateway コンソールで独立ドメインをバインドし、SSL 証明書をアップロードします。詳細については、「HTTPS のサポート」をご参照ください。
   リクエストメソッド	GET と POST がサポートされています。 説明 GET を選択した場合、[リクエストパラメーター] の [パラメーター位置] を QUERY にのみ設定できます。 POST を選択した場合、[リクエストパラメーター] の [パラメーター位置] を QUERY または BODY に設定できます。
   レスポンスタイプ	JSON のみがサポートされています。
   可視範囲	作成後の API の可視性を定義します。有効な値は [ワークスペース] と [プライベート] です。 [ワークスペース]：API は現在のワークスペースのすべてのメンバーに表示されます。 [プライベート]：API は API オーナーにのみ表示されます。権限付与はサポートされていません。 このトピックでは、[ワークスペース] を例として使用します。

3. API パラメーターを設定します。

   API 編集ページで、API パラメーターを設定します。次の図は設定例を示しています。

   1. API のデータソースを選択します。

      [テーブルの選択] セクションで、API の生成に使用するデータソーステーブルを選択します。

      パラメーター	説明
      データソースタイプ	API を作成するデータソースのタイプを選択します。このトピックでは、MySQL を例として使用します。
      データソース名	選択したタイプのデータソースの名前で、このデータソースに基づいて API を生成します。このトピックでは、「パート 1: データソースを作成し、ネットワーク接続を設定する」で作成した rds_workshop_log データソースを例として使用します。
      データソース環境	標準モードのワークスペースは、開発環境または本番環境のデータソースへのアクセスをサポートします。2 つの環境の違いの詳細については、「基本モードと標準モードのワークスペース」をご参照ください。このトピックでは、[本番環境] を例として使用します。
      データテーブル名	API を生成するデータソース内のデータテーブルを選択します。このトピックでは、rds_workshop_log データソース内の rpt_user_info_all_d テーブルを例として使用します。

   2. リクエストパラメーターとレスポンスパラメーターを定義します。

      データテーブルを選択すると、[パラメーターの選択] セクションにテーブルのすべてのフィールドが自動的に表示されます。API のリクエストパラメーターとレスポンスパラメーターとして使用するフィールドを選択します。フィールドをソートするには、対象のフィールドを [ソートフィールド] セクションに追加し、その順序を調整します。

      この例では、リクエストパラメーターは uid で、レスポンスパラメーターはテーブル内のすべてのフィールドです。

      説明

      右側のナビゲーションウィンドウで、[リクエストパラメーター] または [レスポンスパラメーター] をクリックして、フィールドタイプ、サンプル値、デフォルト値などのパラメーター設定を変更します。要件に基づいてこれらの設定を構成できます。

4. API リソースグループを設定します。

   API 編集ページの右側にある [サービスリソースグループ] をクリックして、リソースグループを設定します。デフォルトの DataService Studio の公共リソースグループは提供終了となるため、新しい API が排他的なサービスリソースグループを使用するように設定する必要があります。DataService Studio のクォータが設定された サーバーレスリソースグループ (推奨) または DataService Studio 専用リソースグループ のいずれかを選択します。

ステップ 5：API のテスト

API を作成した後、公開する前にテストする必要があります。API 編集ページの右上隅にある [テスト] をクリックして、リクエストと戻り値が期待どおりであることを確認します。この例では、uid リクエストパラメーターの値を 0016359810821 に設定し、結果をテストします。テストの詳細については、「API のテスト」をご参照ください。

ステップ 6：API の公開

テストに合格した API は公開する必要があります。API が公開されると、他のサービスから呼び出すことができます。API 編集ページの右上隅にある [送信] をクリックし、公開するバージョンを選択します。API が公開されると、API Gateway で表示できます。公開の詳細については、「API の公開」をご参照ください。

ステップ 7：API の呼び出し

API の呼び出しには、以下の認証方式がサポートされています。要件に応じていずれかを選択できます：

• 簡易認証：セキュリティは低いですが、レポートやデータダッシュボードなどのシナリオに適しています。

• 暗号化署名認証：セキュリティが高く、アプリケーション開発シナリオに適しています。

1. DataService Studio の上部メニューバーで [サービス管理] をクリックして、サービス管理ページを開きます。

2. 左側のナビゲーションウィンドウで [API 呼び出し] を選択します。

   公開された API は API Gateway で利用できます。API Gateway SDK を使用して API を呼び出すことができます。詳細については、「クライアントからの API 呼び出し例」をご参照ください。

ステップ 8：API の表示と管理

公開された API は、サービス管理ページで表示および管理できます。上部のナビゲーションバーで [サービス管理] をクリックして、公開済みの API を表示し、関連する管理操作を実行します。