Data Map を使用した DataService Studio API の検索と表示 - DataWorks - Alibaba Cloud - DataWorks

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

API 検索ページ

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

DataWorks コンソールにログインします。左側のナビゲーションウィンドウで、[データガバナンス] > [データマップ] を選択します。表示されるページで、[データマップに移動] をクリックします。
検索ボックスの上部で、API カテゴリを選択します。

検索バーの左側にある検索タイプのドロップダウンメニューには、コード、API、[Dataset] の 3 つのグループがあります。API グループで API を選択します。

API の検索

API カテゴリの下の検索ボックスに、API ID、API パス、API 名、または API の説明 などのキーワードを入力します。

キーワードを入力すると、ドロップダウンリストに一致する上位 10 件の API が表示されます。
目的の API がドロップダウンリストにない場合は、[検索] をクリックしてすべての一致結果を表示します。
左側のペインで、API タイプ、ワークスペース、または オーナー で検索結果を絞り込むことができます。
対象の API を見つけたら、クリックして詳細ページに移動できます。詳細については、「API の詳細の表示」をご参照ください。

API の詳細

API 詳細ページには、API の基本情報、技術情報、パラメーター情報、サンプルに戻る、手順が表示されます。API がコードエディタの場合、追加のコードタブも表示されます。

API の詳細ページは 3 つのエリアに分かれています。上部のエリア ① には、API 名、説明と、API を編集するためのエントリポイントが表示されます。左側のパネルのエリア ② には、API の基本情報と技術情報が表示されます。右側のパネルのエリア ③ では、タブにパラメーター情報、レスポンスの例、リネージ情報、使用上の注意などの詳細なコンテンツが表示されます。次の表で、各エリアについて説明します。

エリア	[説明]
①	API の編集をクリックすると、API のワークスペースに編集ウィンドウが開きます。詳細については、「API テスト、公開、バージョン管理」および「外部 API サービスを登録する」をご参照ください。説明アカウントが API のワークスペースのメンバーでない場合は、ワークスペースの所有者に連絡して、開発者ロールでメンバーとしてアカウントを追加するよう依頼してください。詳細については、「ワークスペースレベルのサービスに対する権限の管理」をご参照ください。
②	このエリアには、次の API 情報が表示されます： [基本情報]: API の閲覧数、呼び出し回数、API ID、ワークスペース、オーナー、作成日時、更新日時、説明などの詳細が含まれます。 [技術情報]: API タイプ、リクエストメソッド、戻り値の型、データソースタイプ、データソース名、テーブル名などの詳細が含まれます。
③	このエリアには、次の API 情報が表示されます： [パラメーター情報]: API のリクエストパラメーターと返却パラメーターを表示します。 [リクエストパラメーター]: 共通リクエストパラメーターおよびアプリケーションリクエストパラメーターの詳細が含まれます。これには、パラメーター名、パラメータータイプ、パラメーター位置、サンプル値、デフォルト値、説明、タグが含まれます。 [返却パラメーター]：共通レスポンスパラメーターとアプリケーションの戻りパラメーターの詳細([パラメーター名]、[パラメータータイプ]、[サンプル値]、[説明]など)が含まれます。 [サンプルに戻る]: API を公開する前にテストを行い、テスト中に自動保存の正常な戻り値の例を選択すると、テスト結果に基づいてレスポンス例が更新されます。詳細については、「API をテストする」をご参照ください。サンプルに戻るの内容と構造は、API のレスポンス形式を示します。 [データリネージ]：データテーブル、 API、アプリ間の完全なデータリネージを表示します。 DataService Studio API のアップストリームデータリネージは、以下のデータソースタイプをサポートしています：Hologres、 MySQL、 PostgreSQL、 SQL Server、 Oracle、 AnalyticDB for MySQL 3.0、 AnalyticDB for PostgreSQL。説明 APIの生成は、データソースまたはテーブルをカプセル化して作成されます。このため、そのデータリネージには、データテーブル、 API、およびアプリが含まれます。 APIの登録はバックエンドアドレスをカプセル化して作成されるため、そのデータリネージには API とアプリのみが含まれます。データリネージは、[T+1] ベースで生成および更新されます。 [手順]: ノートを編集したり、バージョン履歴の表示して変更履歴を確認したりできます。 [コード]: このタブは、API がコードエディタの場合にのみ表示されます。開発者によって作成されたカスタムクエリコード (SQL など) を表示できます。このタブは、他の API タイプ (ウィザードモード API、登録済み API、またはオーケストレーションサービス API) には表示されません。ウィザードモード API の場合、DataService API 開発エディターで SQL を確認できます。説明 Data Map グローバル検索ボックスでコードスニペットを検索してスクリプトモード API を見つけた場合、システムは自動的にコードタブに遷移します。