DataWorks:DataService Studio の使用開始

DataService Studio への移動

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

手順

1. ステップ 1: データソースを作成し、ネットワーク接続を構成する

   DataService Studio で API を作成する前に、データベースまたはデータウェアハウスを DataWorks データソースとして追加する必要があります。このデータソースは、API のデータを提供します。API 開発中、DataService Studio はこのデータソースにアクセスして、データテーブルのスキーマ情報を取得します。これは、リクエストパラメーターとレスポンスパラメーターを設定するのに役立ちます。API が呼び出されると、DataService Studio はデータソースにアクセスしてクエリを実行します。サポートされているデータソースのリストについては、「DataService Studio のデータソースのリスト」をご参照ください。

   重要

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

2. ステップ 2: API グループを作成する

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

3. ステップ 3: ビジネスプロセスを作成する

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

4. ステップ 4: API を生成する

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

5. ステップ 5: API をテストする

   API を作成した後、それをテストする必要があります。API がテストに合格した後、公開できます。

6. ステップ 6: API を公開する

   テストに合格した API を公開します。API が公開されると、他のサービスから呼び出すことができます。

7. ステップ 7: API を呼び出す

   DataService Studio は、簡易認証または暗号化された署名認証を使用した API の呼び出しをサポートしています。要件に応じてメソッドを選択できます。

8. ステップ 8: API を表示および管理する

   サービス管理ページで公開された API を表示できます。DataService Studio は、非公開、権限付与、API 呼び出し詳細の表示などの管理操作もサポートしています。

ステップ 1: データソースを作成し、ネットワーク接続を構成する

DataService Studio で API を作成する前に、データベースまたはデータウェアハウスを DataWorks データソースとして追加する必要があります。また、API が呼び出されたときに DataWorks がデータソースにアクセスできるように、DataService Studio リソースグループが宛先データソースに接続できることを確認する必要もあります。このトピックでは、rds_workshop_log という名前の MySQL データソースを例として使用し、DataService Studio のパブリックリソースグループとの接続性をテストします。

1. [管理センター] に移動します。

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

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

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

      このトピックでは、MySQL を例として使用します。

   2. データソース情報を構成します。

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

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

      説明

      • オフピーク時に実行できない高コンカレンシータスクがある場合は、専用リソースを使用して高コンカレンシーおよび高頻度の API 呼び出しを確保する必要があります。この場合、DataWorks からデータサービススタジオ専用リソースグループまたはServerless リソースグループを購入して使用できます。

      • Serverless リソースグループを使用する場合は、Serverless リソースグループで DataService Studio のクォータを構成する必要があります。

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

ステップ 2: API グループを作成する

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

1. API Gateway コンソールに移動します。

2. 左側のナビゲーションウィンドウで、[API 管理] > [グループ管理] を選択します。

3. [グループ管理] ページで、[グループの作成] をクリックします。

   このトピックでは、Workshop という名前のグループを例として使用します。

ステップ 3: ビジネスプロセスを作成する

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

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

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

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

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

2. ビジネスプロセスのパラメーターを構成します。

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

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

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

ステップ 4: API を生成する

作成したビジネスプロセスで API を作成します。

1. API を生成します。

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

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

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

2. 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 オーナーにのみ表示されます。権限付与はサポートされていません。 このトピックでは、[ワークスペース] を例として使用します。
   宛先フォルダ	左側のビジネスプロセスで API が保存されるフォルダを定義します。ビジネスプロセスを作成していない場合は、作成してください。詳細については、「ステップ 3: ビジネスプロセスを作成する」をご参照ください。

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 のクォータが構成されている Serverless リソースグループまたはデータサービススタジオ専用リソースグループのいずれかを選択します。

ステップ 5: API をテストする

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

ステップ 6: 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 を表示し、管理操作を実行できます。