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

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

API 検索ページ

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

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

API の検索

API カテゴリの下の検索ボックスに、API ID、APIPath、API Name、API Description などのキーワードを入力します。

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

API 詳細

API 詳細ページには、API の Basic Information、Technical Information、Parameter Information、Sample Response、Instructions が表示されます。API が Script Mode の場合、追加の Code タブも表示されます。

領域	[Description]
①	Edit API をクリックして、API のワークスペースで編集ウィンドウを開きます。詳細については、「API のテスト、公開、およびバージョン管理」および「外部 API サービスを登録する」をご参照ください。説明アカウントが API のワークスペースのメンバーでない場合は、ワークスペースの所有者に連絡して、開発者ロールを持つメンバーとしてアカウントを追加するよう依頼してください。詳細については、「ワークスペースレベルのサービスに対する権限の管理」をご参照ください。
②	この領域には、次の API 情報が表示されます。 [Basic Information]：API の Views、Number of Calls、API ID、Workspace、Owner、Created At、Last Updated、Description などが含まれます。 [Technical Information]：API Type、Request Method、Response Type、Data Source Type、Data Source Name、Table Name などの詳細が含まれます。
③	この領域には、次の API 情報が表示されます。 [Parameter Information]: API の Request Parameters と Response Parameters を表示します。 Request Parameters：Common Request ParametersとAPI Request Parametersの詳細が含まれます。これには、Parameter Name、Parameter Type、Parameter Position、Sample Value、Default Value、Description、およびラベルが含まれます。 [Response Parameters]：Common Response Parameters と API Response Parameters には、Parameter Name、Parameter Type、Sample Value、Description などの詳細が含まれます。 [Sample Response]：API を公開する前に、テスト中に Save the correct response example automatically を選択してテストした場合、レスポンス例はテスト結果に基づいて更新されます。詳細については、「API のテスト」をご参照ください。Sample Response の内容と構造は、API のレスポンス形式を示しています。 Lineage Information: データテーブル、API、アプリ間の完全なデータリネージを表示します。 DataService Studio API のアップストリームデータリネージは、次のデータソースタイプをサポートしています: Hologres、MySQL、PostgreSQL、SQL Server、Oracle、AnalyticDB for MySQL 3.0、および AnalyticDB for PostgreSQL。説明 API Generation は、データソースまたはテーブルをカプセル化することによって作成されます。そのため、そのデータリネージにはデータテーブル、 API、およびアプリが含まれます。 Register API はバックエンドアドレスをカプセル化して作成されるため、そのデータリネージには API とアプリのみが含まれます。データリネージは、[T+1] ベースで生成および更新されます。 [Instructions]：ノートをEditするか、View Versionsして変更履歴を確認することができます。 [Code]: このタブは、API が Script Mode の場合にのみ表示され、開発者が作成したカスタムクエリコード (SQL など) を表示できます。このタブは、他の API タイプ (ウィザードモード API、登録済み API、またはオーケストレーションサービス API) には表示されません。ウィザードモード API の場合は、DataService API 開発エディターで SQL を確認できます。説明 Data Map グローバル検索ボックスでコードスニペットを検索してスクリプトモード API を特定すると、システムは自動的にCode タブに遷移します。