DataWorks:DataService Studio のクイックスタート

API 開発

データプッシュ

DataService Studio はデータプッシュ機能をサポートしており、スケジュールに基づいてターゲットオーディエンスにデータを積極的に送信できます。データプッシュタスクを作成して、さまざまなデータソースからのリッチテキストやテーブルなどのコンテンツをカスタマイズおよび編成できます。また、ビジネスニーズに基づいてプッシュ頻度を設定し、さまざまな消費者向けの受信者とチャネルを設定することもできます。これにより、データ配信効率が向上し、データ消費シナリオが拡大します。詳細については、「データプッシュ」をご参照ください。

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

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

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

この例では、rds_workshop_log という名前の MySQL データソースを作成し、サーバーレスリソースグループとの接続をテストする方法を示します。

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

2. 左側のナビゲーションウィンドウで、Data Sources をクリックします。

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

   1. Add Connection をクリックし、データソースタイプを選択します。

      この例では MySQL を使用します。

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

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

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

      説明

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

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

      • 接続テストが失敗した場合は、「ネットワーク接続とホワイトリスト」の指示に従って設定を確認してください。

   4. Complete をクリックしてデータソースを作成します。

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

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

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

   • 方法 1： アイコンをクリックし、Create Workflow を選択します。

   • 方法 2：左側のナビゲーションウィンドウで、Workflow フォルダを右クリックし、Create Workflow を選択します。

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

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

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

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

ステップ 4：API の生成

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

1. API を生成します。

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

   • 方法 1： アイコンをクリックし、Create API > Generate API を選択します。

   • 方法 2：左側のナビゲーションウィンドウで、宛先のビジネスプロセスを右クリックし、Create > API > Generate API を選択します。

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

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

   設定項目	説明
   Location	API が保存されるビジネスプロセス内のディレクトリ。クリックしてフォルダを選択します。 重要 最初に宛先フォルダを選択することを推奨します。選択できない場合は、まず ビジネスプロセスを作成してください。
   API Mode	API を作成するモードを選択します。コードレス UI またはコードエディタを選択できます。 コードレス UI：コードを記述せずにデータ API を迅速に設定します。 コードエディタ：テーブル結合、複雑なクエリ、集計関数などの高度な機能をサポートしています。高度なクエリ要件を満たすために、API 用にカスタム SQL クエリを記述できます。 このトピックでは、コードレス UI を例として使用します。2 つのモードの詳細については、「API 生成の概要」をご参照ください。
   API Name	API のカスタム名を入力します。このトピックでは、rpt_user_info_all_d を例として使用します。
   APIPath	API のストレージパス。これは、サービスホストに対するリクエストの URI です。このパスは、API 呼び出しアドレスを構築するために使用されます。このトピックでは、/user を例として使用します。
   契約	HTTP と HTTPS がサポートされています。 HTTPS 経由で API を呼び出すには、API をゲートウェイに公開した後、API Gateway コンソールで独立ドメインをバインドし、SSL 証明書をアップロードします。詳細については、「HTTPS のサポート」をご参照ください。
   Request Method	GET と POST がサポートされています。 説明 リクエストメソッドとして GET を選択した場合、Request Parameters の Parameter Position は QUERY にしか設定できません。 リクエストメソッドとして POST を選択した場合、Request Parameters の Parameter Position を QUERY または BODY に設定できます。
   Response Type	JSON のみがサポートされています。
   目に見える範囲	作成後の API の可視性を設定します。オプションはWork spaceとPrivateです。 Work space: API は、現在のワークスペース内のすべてのメンバーに表示されます。 Private：API は API の所有者のみに表示され、承認はサポートされていません。 この例では、表示範囲を Work space に設定します。

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

   API 編集ページで、API パラメーターを設定します。この例では、次の設定を使用します。

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

      Table エリアで、API を生成するためのデータソーステーブルを選択します。

      パラメーター	説明
      Data Source Type	API を作成するデータソースのタイプを選択します。このトピックでは、MySQL を例として使用します。
      Data Source Name	選択したタイプのデータソースの中から、API の生成元となる特定のデータソースを選択します。この例では、ステップ 1: データソースを作成し、ネットワーク接続を構成するで作成した rds_workshop_log データソースを使用します。
      Data Source Environment	標準モードのワークスペースでは、開発環境または本番環境のいずれかにあるデータソースにアクセスできます。詳細については、「ワークスペースモードの違い」をご参照ください。この例では、Production Environment を選択します。
      Data Table Name	API を生成するデータソース内のデータテーブルを選択します。このトピックでは、rds_workshop_log データソース内の rpt_user_info_all_d テーブルを例として使用します。

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

      テーブルを選択すると、そのフィールドが Select Parameters エリアに表示されます。次に、リクエストパラメーターおよびレスポンスパラメーターとして使用するフィールドを選択できます。フィールドをソートするには、対象のフィールドを Sort field エリアに追加し、その順序を調整します。

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

      説明

      右側のナビゲーションウィンドウで、Request Parameters または Response Parameters をクリックして、フィールドタイプ、サンプル値、デフォルト値などのパラメータ設定を変更します。これらの設定は、実際のニーズに合わせて構成してください。

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

   API 編集ページで、右側にある Resource Group for DataService Studio をクリックしてリソースグループを設定します。 デフォルトの DataService Studio のパブリックリソースグループが廃止されるため、新しい API では専用のサービスリソースグループを使用する必要があります。 Serverless リソースグループ (推奨) (DataService Studio 用に設定されたクォータ を持つ)、または データサービススタジオ専用リソースグループのいずれかを選択します。

ステップ 5：API のテスト

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

ステップ 6：API の公開

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

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

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

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

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

1. DataService Studio の上部メニューバーで、Service Management をクリックしてサービス管理ページに移動します。

2. 左側のナビゲーションウィンドウで、Call APIs を選択します。

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

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

Service Management ページでは、公開された API を表示し、非公開、権限付与、呼び出し詳細の表示などの管理操作を実行できます。