データマップを使用すると、ご利用のテナント内のすべてのワークスペースで、基本的なメタデータからパラメーター、サンプルレスポンス、データリネージ、注意事項に至るまで、あらゆる DataService Studio API を検索および検査できます。
API の詳細ページから API を編集するには、ご利用のアカウントがその API を所有するワークスペースのメンバーであり、開発者ロールを持っている必要があります。そうでない場合は、ワークスペース管理者に連絡してください。詳細については、「ワークスペースレベルのサービスの権限を管理する」をご参照ください。
オープン データマップ
-
DataWorks コンソールにログインします。
-
上部のナビゲーションバーで、ご利用のリージョンを選択します。
-
左側のナビゲーションウィンドウで、[データガバナンス] > [データマップ] の順に選択します。
-
表示されるページで、[データマップへ移動] をクリックします。
-
Data Map ホームページで、検索ボックスの下にある [API] を [タイプ] ドロップダウンリストから選択します。
API の検索
データマップは次のフィールドを検索します。
| 検索可能なフィールド | 例 |
|---|---|
| API ID | 数値識別子 |
| API パス | API エンドポイントの URL パス |
| API 名 | API の表示名 |
| API の説明 | 説明テキストからのキーワード |
API を検索するには:
-
検索ボックスにキーワードを入力します。最初の 10 個の一致する API が予備結果としてドロップダウンリストに表示されます。
-
必要な API がドロップダウンリストにない場合は、[検索] をクリックします。キーワードに一致するすべての API が表示されます。
-
結果を絞り込むには、左側のフィルターを使用します。API タイプ、[ワークスペース]、および所有者です。
-
API 名をクリックして詳細ページを開きます。
API の詳細表示
API の詳細ページは 3 つのエリアに分かれています。
エリア 1：編集アクセス
「[API の編集]」をクリックして、API の構成タブをそのワークスペースで開き、編集します。詳細については、「API の公開」および「API の登録」をご参照ください。
エリア 2：基本情報と技術情報
| セクション | フィールド |
|---|---|
| 基本情報 | 表示回数、呼び出し回数、API ID、ワークスペース、API オーナー、作成時間、更新時間、API の説明 |
| 技術情報 | API タイプ、リクエストメソッド、戻り値の型、データソースタイプ、データソース名、テーブル名 |
エリア 3：パラメーター、サンプルレスポンス、リネージ、および注意事項
パラメーター情報
[パラメーター情報] タブには、2 つのサブタブがあります。
-
[リクエストパラメーター] — パラメーター名、パラメータータイプ、パラメーターの場所、サンプル値、デフォルト値、説明、タグを含む、共通およびアプリケーションリクエストパラメーターを一覧表示します。
-
[レスポンスパラメーター] — パラメーター名、パラメータータイプ、サンプル値、説明を含む、共通およびアプリケーションレスポンスパラメーターを一覧表示します。
サンプルレスポンス
API リクエストによって返された結果の構造を表示します。サンプル応答は、公開前のテスト中に[正しい応答例を自動的に保存する]を選択すると、自動的に更新されます。詳細については、「API をテストする」をご参照ください。
系統
テーブル、API、およびアプリケーション間の完全なデータリネージを表示します。
サポートされている祖先データソース: Hologres、MySQL、PostgreSQL、SQL Server、Oracle、AnalyticDB for MySQL 3.0、および AnalyticDB for PostgreSQL。
| API タイプ | リネージの範囲 |
|---|---|
| 生成された API | データテーブル → API → アプリケーション |
| 登録済み API | API → アプリケーションのみ |
リネージ情報は 1 日の遅延で生成および更新されます。
注意事項
[編集] をクリックして API の使用メモを更新するか、[バージョンを表示] をクリックしてバージョン履歴を参照します。