すべてのプロダクト
Search

このプロダクト

    DataWorks:関数のテスト、公開、および使用

    ドキュメントセンター

    DataWorks:関数のテスト、公開、および使用

    最終更新日:Mar 31, 2025

    このトピックでは、関数のテスト、公開、および使用方法について説明します。

    前提条件

    関数が作成され、保存されていること。詳細については、「関数の管理」をご参照ください。

    制限事項

    関数をテストできるのは、ワークスペースの所有者、またはワークスペース管理者、開発、あるいは O&M ロールが割り当てられている RAM ユーザーのみです。詳細については、「ワークスペースレベルのサービスに対する権限の管理」トピックの「RAM ユーザーをワークスペースにメンバーとして追加し、ロールを割り当てる」セクションをご参照ください。

    手順 1：関数をテストする

    1. [dataservice Studio] ページに移動します。

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

      2. [サービス開発] ページの左側のナビゲーションペインで、テストする関数を見つけ、関数の名前をダブルクリックします。

    2. 関数の構成タブで、右上隅にある [テスト] をクリックします。

      image

    3. [関数のテスト] ダイアログボックスで、入力パラメーターを指定し、[OK] をクリックします。

      下部にある [実行結果] タブで実行ステータスを確認できます。テストが失敗した場合は、エラーメッセージに基づいて変更を行い、関数を再度テストします。

    手順 2：関数を公開する

    関数をテストした後、関数を公開できます。

    1. [サービス開発] ペインの左側のナビゲーションペインで、テスト済みの関数を見つけ、関数の名前をダブルクリックします。

    2. 関数の構成タブで、トップツールバーの [送信] をクリックします。

    3. 関数の構成タブの右側のナビゲーションペインで、[バージョン] をクリックします。[バージョン] タブで、[公開可能] 状態のバージョンを見つけ、[アクション] 列の [公開] をクリックします。

      説明

      関数が公開された後、関数の構成タブの右側のナビゲーションペインにある [バージョン] をクリックして公開レコードを表示できます。また、[アクション] 列の [バージョンの詳細] または [ロールバック] をクリックすることもできます。

    手順 3：関数を使用する

    シナリオ

    • 関数を API のプリフィルターとして使用する場合、API が呼び出されると、関数は API のリクエストパラメーターを前処理します。

    • 関数を API のポストフィルターとして使用する場合、API が呼び出されると、関数は API のレスポンスを処理して再構築します。

    制限事項

    • 1 つ以上の関数を API のプリフィルターとして使用し、1 つ以上の関数を API のポストフィルターとして使用する場合は、フィルターとして同じタイプの関数を使用する必要があります。Aviator 関数または Python 関数のいずれかを使用できます。異なるタイプの関数を API のフィルターとして使用することはできません。

    • Python 関数をフィルターとして使用する機能は最適化中です。新しい Python 関数を作成、複製、または公開することはできません。

    関数を API のフィルターとして使用する

    1. [サービス開発] ペインで、目的の ビジネスプロセス > API が属する をクリックします。

    2. API を見つけ、API をダブルクリックします。API の構成タブが表示されます。

    3. 右側のナビゲーションペインで、[フィルター] をクリックします。

      [フィルター] タブで、ビジネス要件に基づいて [プリフィルターを使用] または [ポストフィルターを使用] を選択します。[関数タイプ] のデフォルト値は [aviator 関数] です。次に、[プリフィルターを使用] または [ポストフィルターを使用] チェックボックスの横にあるドロップダウンリストから 1 つ以上の関数を選択します。複数の関数を選択した場合、関数は、選択された順序に基づいてリクエストパラメーターまたはレスポンスを処理します。

      説明

      • 1 つ以上の関数をフィルターとして指定して、API のリクエストパラメーターまたはレスポンスを処理できます。

      • 使用したい関数が [プリフィルターを使用] または [ポストフィルターを使用] チェックボックスの横にあるドロップダウンリストに表示されない場合は、関数が公開されているかどうかを確認します。関数が公開されていない場合は、関数を公開します。新しい関数を作成して公開することもできます。詳細については、「関数のテスト、公開、および使用」をご参照ください。

    4. [API 操作によって返されるレスポンスのプレビュー] をクリックし、選択した関数の処理結果が期待どおりであるかどうかを確認します。