すべてのプロダクト
Search

このプロダクト

    DataWorks:DataService Studio の API

    ドキュメントセンター

    DataWorks:DataService Studio の API

    最終更新日:Jan 11, 2025

    データマップを使用すると、現在のテナント内のすべてのワークスペースの DataService Studio API を効率的に検索して見つけることができます。

    データマップページに移動して API を検索する

    1. データマップページに移動します。

      DataWorks コンソール にログオンします。 上部のナビゲーションバーで、目的のリージョンを選択します。 左側のナビゲーションペインで、[メタデータ管理] > [データマップ] を選択します。 表示されたページで、[データマップに移動] をクリックします。

    2. データマップのホームページで、検索ボックスの下にある [タイプ] ドロップダウンリストから [API] を選択します。

      image.png

    API を検索する

    1. 検索ボックスに、[API ID]、[API パス]、[API 名]、[API の説明] などのキーワードを入力します。

      キーワードを入力すると、キーワードに一致する最初の 10 個の API がドロップダウンリストに表示されます。これは、システムによって提供される予備的な検索結果です。image.png

    2. 検索ボックスのドロップダウンリストで目的の API が見つからない場合は、[検索] をクリックします。 フィルター条件を満たすすべての API が表示されます。

      image.png

    3. 表示されたページの左側に表示される [API タイプ]、[ワークスペース]、[所有者] パラメーターを設定して、目的の API を検索します。

    4. API の詳細を表示する場合は、API の名前をクリックして API の詳細ページに移動します。 詳細については、「API の詳細を表示する」をご参照ください。

    API の詳細を表示する

    API の詳細ページでは、API に関する次の情報 ([基本情報]、[技術情報]、[パラメーター]、[サンプルレスポンス]、[使用上の注意]) を表示できます。image

    領域

    説明

    1

    この領域では、[API の編集] をクリックして、関連ワークスペースの API の構成タブに移動し、API を編集できます。 詳細については、「API を公開する」および「API を登録する」をご参照ください。

    説明

    現在のログオンアカウントが API が属するワークスペースのメンバーとして追加されていない場合は、ワークスペース管理者に連絡して、アカウントをワークスペースにメンバーとして追加し、アカウントに開発者ロールを割り当てます。 詳細については、「ワークスペースレベルのサービスに対する権限を管理する」をご参照ください。

    2

    この領域では、API に関する次の情報を表示できます。

    • [基本情報]: このセクションでは、[API の表示回数]、[API の呼び出し回数]、[API ID]、[API が属するワークスペース]、[API 所有者]、[作成時刻]、[更新時刻]、[API の説明] など、API に関する基本情報を表示できます。

    • [技術情報]: このセクションでは、[API タイプ]、[リクエストメソッド]、[戻り値の型]、[データソースタイプ]、[データソース名]、[テーブル名] など、API に関する技術情報を表示できます。

    3

    この領域では、API に関する次の情報を表示できます。

    • [パラメーター情報]: このタブでは、API の [リクエストパラメーター] と [レスポンスパラメーター] を表示できます。

      • [リクエストパラメーター]: このサブタブでは、[共通リクエストパラメーター] と [アプリケーションリクエストパラメーター] に関する情報 ([パラメーター名]、[パラメータータイプ]、[パラメーターの場所]、[サンプル値]、[デフォルト値]、[説明]、[タグ] など) を表示できます。

      • [レスポンスパラメーター]: このサブタブでは、[共通レスポンスパラメーター] と [アプリケーションレスポンスパラメーター] に関する情報 ([パラメーター名]、[パラメータータイプ]、[サンプル値]、[説明] など) を表示できます。

    • [サンプルレスポンス]: API をテストし、API の公開前にテスト中に [正しいレスポンス例を自動的に保存する] を選択した場合、サンプルレスポンスはテスト結果に基づいて更新されます。 詳細については、「API をテストする」をご参照ください。 [サンプルレスポンス] タブで、データの内容とデータ構造に基づいて API リクエストによって返された結果を表示できます。

    • [リネージ]: このタブでは、テーブル、API、およびアプリケーションの完全なリネージを表示できます。 Hologres、MySQL、PostgreSQL、SQL Server、Oracle、AnalyticDB for MySQL 3.0、AnalyticDB for PostgreSQL のデータソースタイプを、現在の API の祖先リネージとして使用できます。

      説明

      • [生成された API] の場合、API はデータソースに基づいて、またはテーブルをカプセル化することによって生成されます。 API リネージには、データテーブル、API、およびアプリケーションが含まれます。

      • [登録済み API] の場合、API はバックエンドアドレスをカプセル化することによって取得されます。 API リネージには、API とアプリケーションのみが含まれます。

      • リネージ情報は、[1 日の遅延] で生成および更新されます。

    • [使用上の注意]: このタブでは、[編集] をクリックして API の使用上の注意を変更し、[バージョンの表示] をクリックして API の使用上の注意の履歴バージョンを表示できます。