DataService Studio では、コードレス UI またはコードエディタを使用して API を作成できます。コードレス UI を使用して API を作成する場合、コードを記述することなく、視覚的に API を構成できます。このトピックでは、コードレス UI を使用して API を作成する方法について説明します。
前提条件
[データソース] ページでデータソースが構成されていること。詳細については、「データソースを追加する」をご参照ください。
DataService Studio 用にリソースグループが作成されていること。本番環境では、サーバーレスリソースグループを使用することをお勧めします。詳細については、「準備」をご参照ください。
背景情報
パーソナライズされたクエリ要件がある場合は、DataWorks が提供するコードエディタを使用して API を作成できます。コードエディタを使用して API を作成する場合、API 用の SQL 文をカスタマイズできます。コードエディタでは、テーブル結合クエリ、複雑なクエリ、集計関数などの機能を使用できます。たとえば、フィールドの特定の値範囲内のデータをクエリするためのリクエストパラメータを指定する場合、コードエディタで API を作成できます。
DataService Studio ページに移動する
DataWorks コンソール にログオンします。上部のナビゲーションバーで、目的のリージョンを選択します。左側のナビゲーションウィンドウで、 を選択します。表示されたページで、ドロップダウンリストから目的のワークスペースを選択し、[dataservice Studio に移動] をクリックします。
API を作成する
[サービス開発] ウィンドウで、
アイコンにポインターを移動し、 を選択します。ビジネスプロセスをクリックし、[API] を右クリックして、 を選択することもできます。
[API を生成] ダイアログボックスで、パラメータを構成します。
パラメータ
説明
[API モード]
API を作成するために使用されるモード。有効な値：[ウィザードモード] および [スクリプトモード]。この例では、[ウィザードモード] を選択します。
[API 名]
API の名前。名前は 4 ～ 50 文字で、文字、数字、およびアンダースコア(_)を含めることができます。名前は文字で始める必要があります。
[API パス]
API のパス。パスは、サービスホストアドレスからの相対パスである API リクエストパスです。例：/user。
説明パスは最大 200 文字で、文字、数字、アンダースコア(_) 、およびハイフン(-)を含めることができます。パスはスラッシュ(/)で始める必要があります。
[プロトコル]
API が使用するプロトコル。有効な値：[HTTP] および [HTTPS]。
HTTPS を使用して API を呼び出す必要がある場合は、API が API Gateway に公開された後、API Gateway コンソールで独立ドメイン名を API に関連付ける必要があります。また、API Gateway コンソールに Secure Sockets Layer (SSL) 証明書をアップロードする必要があります。詳細については、「API 操作で HTTPS を有効にする」をご参照ください。
[リクエストメソッド]
リクエストメソッド。有効な値：[GET] および [POST]
説明[リクエストメソッド] パラメーターで [GET] を選択した場合、[パラメーターの位置] パラメーターでは [QUERY] のみを選択できます。 [リクエストメソッド] パラメーターで [POST] を選択した場合、[パラメーターの位置] パラメーターでは [QUERY] または [BODY] を選択できます。
[レスポンスタイプ]
API から返されるデータの形式。値を [JSON] に設定します。
[表示範囲]
API が表示されるユーザーの範囲。有効な値：
[ワークスペース]：API は現在のワークスペースのすべてのメンバーに表示されます。
[プライベート]：API は所有者にのみ表示され、API の権限を他のメンバーに付与することはできません。
説明このパラメータを [プライベート] に設定すると、ワークスペース内の他のメンバーは API リストで API を表示できません。
[ラベル]
[ラベル] ドロップダウンリストからタグを選択します。詳細については、「API タグを作成および管理する」をご参照ください。
説明タグは最大 20 文字で、文字、数字、およびアンダースコア(_)を含めることができます。1 つの API に最大 5 つのタグを設定できます。
[説明]
API の説明。説明は最大 2,000 文字です。
[保存先フォルダ]
API を保存するフォルダ。ドロップダウンリストからビジネスプロセスを選択できます。ビジネスプロセスを選択すると、ビジネスプロセスにフォルダが生成され、API がそのフォルダに保存されます。デフォルトでは、フォルダの形式は ビジネスプロセス/ビジネスプロセス名/API です（例：Business Processes/ceshi/API）。
[OK] をクリックします。
API を構成する
1. テーブルを選択する
API リストで API をダブルクリックします。表示されたタブで、[データソースタイプ]、[データソース名]、[データソース環境]、および [テーブル名] パラメータを [テーブルの選択] セクションで構成します。
構成する必要のあるパラメータは、選択したデータソースタイプによって異なります。コンソールの値が優先されます。
API のテーブルを選択する前に、Data Integration でデータソースを構成する必要があります。[テーブル名] フィールドにテーブル名を入力して、使用するテーブルを検索できます。
標準モードのワークスペースの場合、[データソース環境] パラメータに [本番] または [環境] を選択できます。詳細については、「基本モードのワークスペースと標準モードのワークスペースの違い」をご参照ください。
API の MaxCompute テーブルを選択した場合、高速化のために、[高速化メソッド] パラメータに [高速化サービス] または [MCQA] を選択できます。高速化サービスは DataWorks が提供する高速化メソッドであり、MCQA は MaxCompute が提供する高速化メソッドです。[高速化サービス] を選択した場合は、高速化項目が作成されていることを確認する必要があります。詳細については、「API ベースのデータクエリの高速化ソリューション」をご参照ください。
API を作成すると、API 構成タブが表示されます。その後、API のテーブルを選択できます。
2. パラメータの選択セクションのパラメータを構成する
[パラメータの選択] セクションで、API のリクエストパラメータとレスポンスパラメータを構成します。
[テーブルの選択] セクションでテーブルを選択すると、テーブル内のすべてのフィールドが [パラメータの選択] セクションに表示されます。[リクエストパラメータとして設定] 列で、リクエストパラメータとして指定するフィールドのチェックボックスをオンにします。[レスポンスパラメータとして設定] 列で、レスポンスパラメータとして指定するフィールドのチェックボックスをオンにします。
API が返すデータを特定のフィールドに基づいてソートするには、フィールドを見つけて、[フィールドソートに追加] 列の [追加] をクリックします。[追加] をクリックすると、フィールドが [ソートフィールド] セクションに追加されます。
ソート機能を使用すると、API が返すデータのソート基準となるフィールドを指定できます。[ソートフィールド] セクションでシーケンス番号が小さいフィールドほど、データソートの優先順位が高くなります。[上に移動] または [下に移動] をクリックして、フィールドのシーケンスを調整できます。各フィールドの [ソート] 列で [昇順] または [降順] を選択して、ソートモードを指定できます。
3. リクエストパラメータを構成する
右側のナビゲーションウィンドウで、[リクエストパラメータ] タブをクリックします。[リクエストパラメータ] タブで、ビジネス要件に基づいてパラメータを構成します。
結果をプレビューする前に、API の各リクエストパラメータの値の例、デフォルト値、および説明などの情報を構成する必要があります。
一致効率を向上させるには、インデックス付きフィールドをリクエストパラメータとして指定します。
コードレス UI を使用して API を作成する場合、1 つのフィールドに 2 つのパラメータを構成して値の範囲を生成することはできません。1 つのフィールドに複数のパラメータを構成する場合は、コードエディタを使用して API を作成できます。詳細については、「コードエディタを使用して API を作成する」をご参照ください。
パラメータ | 説明 |
[パラメータ名] | リクエストパラメータの名前。名前は最大 64 文字で、文字、数字、アンダースコア(_) 、およびハイフン(-)を含めることができます。名前は文字で始める必要があります。 |
[バインドフィールド] | 値は変更できません。値を変更する場合は、コードエディタを使用して API を作成します。詳細については、「コードエディタを使用して API を作成する」をご参照ください。 |
[タイプ] | リクエストパラメータのタイプ。有効な値：[STRING]、[INT]、[LONG]、[FLOAT]、[DOUBLE]、および [BOOLEAN]。 |
[位置] | リクエストパラメータの位置。有効な値：[QUERY] および [BODY]。 説明 1 つ以上のリクエストパラメータの [位置] パラメータを [BODY] に設定した場合、[content-type] パラメータを構成して、リクエストボディのリクエストパラメータの形式を定義する必要があります。 [content-type] パラメータの有効な値：
|
[演算子] | リクエストパラメータの値を指定した値に関連付けたり比較したりするために使用される演算子。次の演算子のいずれかを選択できます。
説明 [テーブルの選択] セクションで [データソースタイプ] パラメータを [tablestore] に設定した場合、[演算子] パラメータは [等しい] にのみ設定できます。 |
[必須] | リクエストパラメータが必須かどうかを指定します。 |
[値の例] | リクエストパラメータの値の例。 |
[デフォルト値] | リクエストパラメータのデフォルト値。 |
[説明] | リクエストパラメータの説明。 |
4. レスポンスパラメータを構成する
右側のナビゲーションウィンドウで、[レスポンスパラメータ] タブをクリックします。[レスポンスパラメータ] タブで、パラメータを構成します。
レスポンスパラメータを構成します。
パラメータ
説明
[パラメータ名]
レスポンスパラメータの名前。名前は最大 64 文字で、文字、数字、アンダースコア(_) 、およびハイフン(-)を含めることができます。名前は文字で始める必要があります。
[バインドフィールド]
値は変更できません。
[タイプ]
リクエストパラメータのタイプ。有効な値：[STRING]、[INT]、[LONG]、[FLOAT]、[DOUBLE]、および [BOOLEAN]。
[値の例]
レスポンスパラメータの値の例。
[説明]
レスポンスパラメータの説明。
[戻り結果のページネーション] パラメータを構成します。
[ページネーション] を選択しない場合、API はデフォルトで最大 2,000 レコードを返します。
2,000 レコードを超えるレコードが返される可能性がある場合は、[ページネーション] を選択することをお勧めします。[ページネーション] を選択した場合は、[リソースグループ] タブに移動して、選択したリソースグループに基づいて [1 回のリクエストあたりのデータレコードの最大数] パラメータを構成できます。
[戻り結果のページネーション] を有効にすると、次の共通パラメータを使用できます。
共通リクエストパラメータ
pageNum：ページ番号。
pageSize：ページごとに返されるエントリの数。
共通レスポンスパラメータ
pageNum：ページ番号。
pageSize：ページごとに返されるエントリの数。
totalNum：返されるエントリの総数。
説明リクエストパラメータは API ではオプションです。API のリクエストパラメータを指定しない場合は、[ページネーション] を選択する必要があります。
5. フィルタを構成する
API のリクエストパラメータを前処理したり、API から返された結果を処理したりする必要がある場合は、次の手順を実行して API のフィルタを構成できます。右側のナビゲーションウィンドウで、[フィルタ] タブをクリックします。[フィルタ] タブで、ビジネス要件に基づいて [プリフィルタを使用] または [ポストフィルタを使用] を選択します。[関数タイプ] パラメータを構成した後、[プリフィルタを使用] または [ポストフィルタを使用] チェックボックスの横にあるドロップダウンリストから 1 つ以上の関数を選択します。複数の関数を選択した場合、関数は選択された順序に基づいてパラメータの処理に使用されます。その後、[API 操作によって返されたレスポンスのプレビュー] をクリックして、選択した関数の処理結果が期待どおりかどうかを確認できます。フィルタの作成および使用方法の詳細については、「Aviator 関数を作成する」および「Python 関数を作成する」をご参照ください。
Python 関数をフィルタとして使用する場合、DataWorks Professional Edition 以上をアクティブ化し、DataService Studio の共有リソースグループを使用する必要があります。
Aviator 関数をフィルタとして使用する場合、すべての DataWorks エディションがサポートされていますが、DataService Studio 専用のリソースグループを使用する必要があります。
使用する関数がドロップダウンリストにない場合は、関数が公開されているかどうかを確認します。関数が公開されていない場合は、関数を公開します。関数を作成して公開することもできます。詳細については、「関数のテスト、公開、および使用」をご参照ください。
6. DataService Studio のリソースグループを構成する
右側のナビゲーションウィンドウで、[リソースグループ] タブをクリックします。[リソースグループタイプ] セクションで、[スキーマ] パラメータを構成します。
[スキーマ] パラメータには、[dataservice Studio 専用リソースグループ] または [dataservice Studio 共有リソースグループ] を選択できます。[dataservice Studio 専用リソースグループ] を選択した場合は、[DataService Studio 専用リソースグループ] ドロップダウンリストから専用リソースグループを選択します。[dataservice Studio 共有リソースグループ] を選択した場合は、リソースグループを選択する必要はありません。DataWorks は共有リソースグループを自動的に使用して API を生成します。
説明[スキーマ] パラメータに [dataservice Studio 共有リソースグループ] を選択した場合、リソースグループはテスト環境でのみ使用できます。本番環境ではリソースグループを使用しないことをお勧めします。
使用するリソースグループがドロップダウンリストに表示されない場合は、[リソースグループ] ページに移動し、リソースグループを見つけて、[アクション] 列の [ワークスペースの関連付け] をクリックして、リソースグループをワークスペースに関連付けます。
使用するリソースグループがドロップダウンリストに表示されているが選択できない場合は、[リソースグループ] ページに移動し、リソースグループを見つけて、[アクション] 列の
> > [クォータの管理] を選択して、[クォータの管理] ダイアログボックスに移動します。[クォータの管理] ダイアログボックスで、アクション[使用済み CU]最小 CU[dataservice Studio] のリソースグループの または パラメータを手動で構成します。リソースグループの課金方法が従量課金制の場合は、[使用済み CU] パラメータを構成する必要があります。リソースグループの課金方法がサブスクリプションの場合は、[最小 CU] パラメータを構成する必要があります。
[環境構成] セクションで、[メモリ]、[関数のタイムアウト]、および [1 回のリクエストあたりのデータレコードの最大数] パラメータを構成できます。
[関数のタイムアウト] パラメータの最大値は、選択したリソースグループのタイプと使用する API Gateway インスタンスタイプによって異なります。
共有 API Gateway インスタンス：このパラメータの最大値は 30000 です。
専用 API Gateway インスタンス：[DataService Studio 共有リソースグループ] を選択した場合、このパラメータの最大値は 30000 です。[DataService Studio 専用リソースグループ] を選択した場合、このパラメータの最大値は 90000 です。
説明API 操作の応答時間は、SQL 文の実際の実行時間によって異なります。応答タイムアウトによるリクエストの失敗を防ぐには、SQL 文の実際の実行時間に基づいて [タイムアウト期間] を構成します。
[1 回のリクエストあたりのデータレコードの最大数] パラメータの最大値は、選択したリソースグループのタイプによって異なります。
[DataService Studio 共有リソースグループ] を選択した場合、このパラメータの最大値は 2000 です。
[DataService Studio 専用リソースグループ] を選択した場合、このパラメータの最大値は 10000 です。
説明返される結果の総数に制限はありません。返される結果の数は、実際のクエリ結果の数と同じです。
7. API を保存してコミットする
上部のツールバーにある 
アイコンをクリックします。API が保存されると、選択したリソースグループがテスト中に有効になります。
API が構成されたら、API をテストできます。詳細については、「API をテストする」をご参照ください。
テストが成功したら、右上隅にある [送信] をクリックします。
API 構成タブの右側のナビゲーションウィンドウで、[バージョン] をクリックします。公開する API バージョンを見つけて、[アクション] 列の [公開申請] をクリックして、申請ページに移動します。デフォルトのアプリケーションタイプ [データサービス API を公開] を使用し、[申請理由] フィールドに申請理由を入力します。次に、[権限の申請] をクリックして申請を送信します。
DataWorks 承認センターで承認ポリシーを定義した場合、API を公開するには API を承認する必要があります。詳細については、「承認センター」をご参照ください。
API が公開されると、API が呼び出されたときに DataService Studio のリソースグループの構成が有効になります。
[サービス開発] タブで、左側のナビゲーションウィンドウに登録済みの API を見つけて管理できます。たとえば、API の複製や削除ができます。[サービス管理] タブで、公開済みの API を見つけて、公開済みの API の詳細を表示できます。詳細については、「API の表示、削除、移動、複製、複数の API に対するバッチ操作の実行、およびコード検索機能を使用した API の検索」をご参照ください。
コードレス UI からコードエディタに切り替える
API の構成タブで、コードレス UI からコードエディタに切り替えることができます。
[サービス開発] ウィンドウで、目的の [API] が属する をクリックします。
API を見つけてダブルクリックします。API の構成タブが表示されます。
上部のツールバーにある
アイコンをクリックします。[注記] メッセージで、[OK] をクリックします。その後、[クエリ SQL の編集] セクションで API の SQL 文を表示できます。
重要DataService Studio では、コードレス UI からコードエディタへの切り替えのみが可能です。
コードレス UI からコードエディタに切り替えた後、コードレス UI に戻すことはできません。