API インサイトで不足している API データの特定と修復
欠落している要素をリンクし、完全な API レコードを検証することで、 API インサイト ワークスペースで欠落している API データを特定して修正します。
メタデータが欠落していると、API ディスカバリー、ライフサイクルトラッキング、および所有権の説明責任の有効性が低下する可能性があります。欠落している一般的な要素は次のとおりです。
- ビジネスコンテキスト
- 所有グループ
- 製品モデル
- 設計の詳細
欠損データを解決することで、依存関係と所有権をより完全かつ正確に把握できるようになり、影響度評価とサービス管理が向上します。
API インサイトワークスペースの [概要] タブでは、構成管理データベース (CMDB)内の不完全なデータや欠落しているデータを強調表示することで、API の使いやすさ、ガバナンス、および統合を改善できます。
ロール別に不足している API データの修正
次のロールは、API で欠落しているメタデータを特定して解決できます。
- sn_api_insights_ws.api_mgmt_architect ロールを持つエンタープライズアーキテクトは、 API インサイト ワークスペースの [概要] タブにアクセスし、欠落しているデータのタイプごとに専用のタイルを使用して、欠落している API 情報を修復できます。
- sn_cmdb_admin ロールを持つ CMDB アドミニストレーターは、 API インサイト ワークスペースの [概要] タブにアクセスし、不足している API 属性棒グラフ内の棒を選択して、不足しているメタデータを特定して更新できます。
主要メトリクスの監視
組織内の API に関連付けられた次の不足データを監視できます。
- 不足しているビジネスコンテキスト
- API がどのビジネスコンテキストにも関連付けられていないと、どのビジネス領域が API を提供しているかに関する明確さとガバナンスが低下します。
- 不足している所有グループ
- 所有グループがアサインされていない API はガバナンスに影響します。所有グループをアサインすることで、修復の追跡、アクセスの管理、問題の迅速な解決が簡素化されます。
- 不足している製品モデル
- 製品モデルがアサインされていない API があると、正確なレポートを提供する能力や、バージョンアップされた API との対話が制限されます。
- 欠損設計
- 設計の具現化が行われていない API は、システムへの完全な統合の妨げとなります。これらの API を、設計時点での対応するもの (デジタルインターフェイスレコードなど) とリンクさせることで、使いやすさと運用効率が向上します。
不足している API データの解決
ビジネスコンテキストの関係、または所有グループ、製品モデル、または設計の参照を作成して、API と CMDB内の他の CI 間の接続を確立することで、欠落している API データを解決できます。
API インサイトで次の関係または参照を確立して、不足している API データを解決できます。
- API とビジネスコンテキストの関係
- API を特定のビジネスコンテキストにリンクさせ、API が使用されるコンテキストを定義し、CMDB で関係レコードを作成します。
- API から所有グループへの参照
- API をガバナンス、アクセス制御、およびメンテナンスを担当するグループにリンクさせます。CMDB でレコードを作成せずに、参照として機能します。
- API から製品モデルへの参照
- API を製品モデルにリンクさせ、API のバージョニング、製品ライン、およびライフサイクルステージに関する情報を提供します。CMDB でレコードを作成せずに、参照として機能します。
- API から設計への参照
- API をランタイムインターフェイスまたは設計時インターフェイスにリンクさせます。CMDB レコードを作成せずに、参照として機能します。
欠落している API データを修復するための関係性または参照を作成します
ビジネスコンテキスト、所有グループ、製品モデル、設計などの主要な属性を持たない API の関係または参照を作成することで、組織内の API エコシステムの運用効率を向上させます。
始める前に
必要なロール:sn_api_insights_ws.api_mgmt_architect、sn_cmdb_admin
このタスクについて
利用可能な欠損データカテゴリは次のとおりです。
- ビジネスコンテキストがありません
- 不足している所有グループ
- 不足している製品モデル
- 欠損設計注:デジタル統合管理プラグイン (sn_apm_di) がアクティブ化されている場合にのみ表示されます。
重要:
多数の API の関係を作成する場合、API のタグに基づいて関係の作成を自動化できます。詳細については、「内でのタグベースの関係マッピングの作成の自動化 API インサイト」を参照してください。
手順
- 移動先 .
- デフォルトで選択されていない場合は、[概要] タブを選択します。
-
不足しているデータカテゴリを選択して、その属性がない API のリストを開きます。
- sn_api_insights_ws.api_mgmt_architect ロールを持つユーザーとして、[不足している API データ (APIs missing data)] セクションで、特定の欠損データカテゴリに表示される番号を選択します。
- sn_cmdb_admin ロールを持つユーザーとして、不足している API データ棒グラフのカテゴリバーを選択します。
- [不足している API データ (APIs missing data)] ページで、API 名の横にあるチェックボックスをオンにします。
-
欠損データを解決します。
- 不足しているビジネスコンテキストを解決するには、[関係を作成] を選択します。
- 不足している所有グループ、製品モデル、または設計を解決するには、[参照を作成 (Create reference)] を選択します。
- アプリケーションサービスの [ 名前 ] 列の横にあるチェックボックスをオンにします。
-
必要な接続のタイプに基づいて、関係または参照を確立します。
- ビジネスコンテキストの場合は、[関係を作成] を選択します。
- 所有グループ、製品モデル、または設計の場合は、[参照を作成 (Create reference)] を選択します。
- 表示されるダイアログボックスで、[作成] を選択します。