DataWorks:DataService Studio の使用開始

DataService Studio ページに移動する

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

手順

1. 手順 1：データソースを追加し、データソースと DataService Studio 用の DataWorks リソースグループ間のネットワーク接続を確立する

   DataService Studio を使用して API を作成する前に、データベースまたはデータウェアハウスをデータソースとして DataWorks に追加する必要があります。その後、データソースを使用して API を作成できます。 API の開発中に、DataService Studio はデータソースにアクセスして、API の作成元のデータテーブルのスキーマを取得し、API のリクエストパラメーターとレスポンスパラメーターを構成するのに役立ちます。 API を呼び出すと、DataService Studio はデータソースにアクセスしてクエリリクエストを実行します。

2. 手順 2：API グループを作成する

   DataService Studio は、API Gateway に基づいて外部サービスを提供します。 API Gateway では、API はグループごとに管理されます。 API を呼び出すには、API 呼び出しアドレスのドメイン名を、API が属する API グループにバインドする必要があります。 DataService Studio を使用して API を作成する前に、API Gateway で API グループを作成する必要があります。

3. 手順 3：ビジネスプロセスを作成する

   DataService Studio は、ビジネスプロセスによって API を開発します。 DataService Studio は、ビジネスプロセスに基づいて API とファイルを整理および管理します。ファイルには関数が含まれています。 DataService Studio を使用して API を作成する前に、ビジネスプロセスを作成する必要があります。

4. 手順 4：API を生成する

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

5. 手順 5：API をテストする

   API を公開する前に、API のテストを実行し、API がテストに合格していることを確認する必要があります。

6. 手順 6：API を公開する

   API がテストに合格した後、API を公開して、他のサービスが API を呼び出せるようにすることができます。

7. 手順 7：API を呼び出す

   DataService Studio では、簡易認証または 暗号化署名認証方式を使用して API を呼び出すことができます。ビジネス要件に基づいて方式を選択できます。

8. 手順 8：API を表示および管理する

   DataService Studio ページの [サービス管理] タブで、公開済みの API を表示し、ビジネス要件に基づいて API を管理できます。たとえば、API の非公開、他のユーザーへの API 呼び出しの承認、API の呼び出し詳細の表示などを行うことができます。

手順 1：データソースを追加し、データソースと DataService Studio 用の DataWorks リソースグループ間のネットワーク接続を確立する

DataService Studio を使用して API を作成する前に、データベースまたはデータウェアハウスをデータソースとして DataWorks に追加する必要があります。データソースと DataService Studio 用の DataWorks リソースグループ間のネットワーク接続が確立されていることを確認します。この例では、rds_workshop_log という名前の MySQL データソースが追加され、データソースと DataService Studio 用の共有リソースグループ間のネットワーク接続がテストされます。

1. SettingCenter ページに移動します。

2. 表示されるページの左側のナビゲーション ウィンドウで、[データ ソース] > [データ ソース] を選択します。[データ ソース] ページが表示されます。

3. データソースを追加し、使用する DataService Studio 用のリソースグループとデータソース間のネットワーク接続をテストします。

   1. [データソースの追加] をクリックし、[データソースの追加] ダイアログボックスでデータソースの種類を選択します。

      この例では、[MySQL] が選択されています。

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

      画面の指示に従って、データソースに関する情報を構成します。詳細については、「MySQL データソースを追加する」をご参照ください。

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

      説明

      • 多数のノードを並列で実行する必要がある場合は、高度に並列で頻繁な API 呼び出しを確実にするために、排他的リソースが必要です。この場合、DataService Studio 専用のリソースグループまたはサーバーレスリソースグループを使用することをお勧めします。詳細については、「DataService Studio 専用リソースグループを作成および使用する」および「サーバーレスリソースグループを作成および使用する」をご参照ください。

      • サーバーレスリソースグループを使用する場合は、リソースグループのクォータを指定する必要があります。詳細については、「サーバーレスグループのクォータを指定する」をご参照ください。

   4. [作成完了] をクリックします。データソースが追加されます。

手順 2：API グループを作成する

DataService Studio は、API Gateway に基づいて外部サービスを提供します。 API Gateway では、API はグループごとに管理されます。 API を呼び出すには、API 呼び出しアドレスのドメイン名を、API が属する API グループにバインドする必要があります。 DataService Studio を使用して API を作成する前に、API Gateway で API グループを作成する必要があります。

1. API Gateway コンソール にログオンします。

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

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

   この例では、Workshop という名前の API グループが作成されます。

手順 3：ビジネスプロセスを作成する

DataService Studio は、ビジネスプロセスによって API を開発し、API の作成に使用される API とファイルをビジネスプロセスに基づいて整理および管理します。ファイルには関数が含まれています。 DataService Studio を使用して API を作成する前に、ビジネスプロセスを作成する必要があります。

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

   [DataService Studio] ページの [サービス開発] ウィンドウで、次のいずれかの方法を使用してビジネスプロセスを作成できます。

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

   • 方法 2：[サービス開発] ウィンドウで [ビジネスプロセス] を右クリックし、[ビジネスプロセスの作成] を選択します。

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

   パラメーター	説明
   [名前]	ビジネスプロセスの名前。ビジネス要件に基づいて名前を指定します。この例では、[DataService] という名前のビジネスプロセスが作成されます。
   [API グループ]	API の管理に使用する API グループ。この例では、手順 2 で作成した [Workshop] API グループが使用されます。 説明 API グループは、特定のシナリオで使用される、または特定のタスクを実行するために使用される API のコレクションです。 API グループは、API Gateway における API の最小管理単位です。 API グループを作成するには、「手順 2：API グループを作成する」をご参照ください。

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

   ビジネスプロセスを作成した後、[サービス開発] ウィンドウでビジネスプロセスの詳細を表示できます。

手順 4：API を生成する

ビジネス要件に基づいて、ビジネスプロセスで API を生成できます。

1. API を生成します。

   [DataService Studio] ページの [サービス開発] ウィンドウで、次のいずれかの方法を使用して API を生成できます。

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

   • 方法 2：[サービス開発] ウィンドウで、作成したビジネスプロセスを右クリックし、[新規] > [API] > [API の生成] を選択します。

2. API のプロパティを構成します。

   [API の生成] ダイアログボックスで、API のプロパティを構成します。次の図は構成例を示しています。 次の表にパラメーターを示します。

   パラメーター	説明
   [API モード]	API を作成するモード。有効な値：ウィザードモードとスクリプトモード。 ウィザードモード：API をすばやく構成できます。このモードで API を構成する場合、コードを記述する必要はありません。 スクリプトモード：複数テーブル結合、複雑なクエリ、集計関数などの高度な機能をサポートしています。このモードでは、上級ユーザーは SQL ステートメントを記述して、クエリ要件に基づいて API をクエリできます。 この例では、ウィザードモードが選択されています。 2 つのモードの詳細については、「概要」をご参照ください。
   [API 名]	API の名前。この例では、rpt_user_info_all_d という名前の API が作成されます。
   [API パス]	API のパス。パスは、サービスホストアドレスを基準とした API リクエストパスです。 API リクエストパスは、API 呼び出しアドレスを連結するために使用されます。この例では、API リクエストパスは /user です。
   [プロトコル]	API を呼び出すプロトコル。有効な値：HTTP および HTTPS。 HTTPS 経由で API を呼び出す場合は、API が API Gateway に公開された後、API Gateway コンソールで、API が属する API グループに独立ドメイン名をバインドする必要があります。また、API Gateway コンソールに Secure Sockets Layer（SSL）証明書をアップロードする必要があります。詳細については、「API の HTTPS ベースの呼び出しを有効にする」をご参照ください。
   [リクエストメソッド]	API のリクエストメソッド。有効な値：GET および POST。 説明 リクエストメソッド パラメーターを GET に設定した場合、API の [リクエスト パラメーター] で構成されている [パラメーターの位置] パラメーターには、QUERY のみを選択できます。 [リクエストメソッド] パラメーターを POST に設定した場合、API の [リクエストパラメーター] で構成されている [パラメーターの位置] パラメーターには、QUERY または BODY を選択できます。
   [レスポンスタイプ]	返されるデータの形式。 JSON のみを選択できます。
   [表示範囲]	API の表示範囲。有効な値：[ワークスペース] および [非公開]。 [ワークスペース]：API は現在のワークスペースのすべてのメンバーに表示されます。 [非公開]：API は API 所有者にのみ表示されます。 API の権限を他のメンバーに付与することはできません。 この例では、[ワークスペース] が選択されています。
   [保存先フォルダ]	[サービス開発] ウィンドウのビジネスプロセスに API を格納するために使用されるフォルダ。ビジネスプロセスが存在しない場合は、作成します。ビジネスプロセスを作成するには、「手順 3：ビジネスプロセスを作成する」をご参照ください。

3. API のパラメーターを構成します。

   API の構成タブで、パラメーターを構成します。次の図は構成例を示しています。

   1. [テーブルの選択] セクションのパラメーターを構成します。

      [テーブルの選択] セクションで、API の生成元の特定のデータソースタイプのテーブルを選択します。次の表にパラメーターを示します。

      パラメーター	説明
      [データソースの種類]	API を作成するデータソースの種類。この例では、MySQL が選択されています。
      [データソース名]	API を生成する、選択した種類のデータソースの名前。この例では、「手順 1：データソースを追加し、データソースと DataService Studio 用の DataWorks リソースグループ間のネットワーク接続を確立する」で追加された rds_workshop_log データソースが選択されています。手順 1：データソースを追加し、データソースと DataService Studio 用の DataWorks リソースグループ間にネットワーク接続を確立する
      [データソース環境]	データソースの環境。標準モードのワークスペースを使用する場合は、開発環境または本番環境のデータソースを選択できます。開発環境と本番環境の違いについては、「基本モードのワークスペースと標準モードのワークスペースの違い」をご参照ください。この例では、[本番] が選択されています。
      [テーブル名]	API の生成元のデータテーブルの名前。この例では、rds_workshop_log データソースの rpt_user_info_all_d テーブルが選択されています。

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

      データテーブルを選択すると、テーブル内のすべてのフィールドが [パラメーターの選択] セクションに自動的に表示されます。ビジネス要件に基づいて、フィールドを API のリクエストパラメーターおよびレスポンスパラメーターとして構成できます。フィールドをソートする場合は、目的のフィールドを [ソートフィールド] セクションに追加して、フィールドの順序を調整できます。

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

      説明

      API の構成タブの右側のナビゲーションウィンドウで、[リクエストパラメーター] または [レスポンスパラメーター] をクリックします。表示されたタブで、リクエストパラメーターまたはレスポンスパラメーターとして構成されているフィールドの情報（タイプ、サンプル値、デフォルト値など）を変更します。ビジネス要件に基づいてフィールドの情報を変更できます。

4. API のリソースグループを構成します。

   API の構成タブの右側のナビゲーションウィンドウで、[リソースグループ] をクリックします。 [リソースグループ] パネルで、[リソースグループタイプ] セクションのパラメーターを構成します。 DataService Studio 用の DataWorks 共有リソースグループは廃止されます。詳細については、「DataService Studio 用の DataWorks 共有リソースグループの廃止に関するお知らせ」をご参照ください。 [スキーム] パラメーターを [DataService Studio 専用リソースグループ] に設定し、DataService Studio 専用リソースグループまたはサーバーレスリソースグループを選択することをお勧めします。詳細については、「サーバーレスグループのクォータを指定するサーバーレス」および「DataService Studio 専用リソースグループを作成および使用する」をご参照ください。

手順 5：API をテストする

手順 6：API を公開する

手順 7：API を呼び出す

1. DataService Studio ページの上部のツールバーで、[サービス管理] をクリックします。 [サービス管理] タブが表示されます。

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

   DataWorks で公開されている API は API Gateway に公開されます。 API Gateway SDK を使用して API を呼び出すことができます。詳細については、「API 呼び出しの例」をご参照ください。

手順 8：API を表示および管理する