[API の詳細 (API details)] ページへのアクセスと使用

[API の詳細] ページにアクセスするには、 ワークスペース > API インサイトで [ API] タブを選択し、API データテーブルの [ 名前 ] 列から API を選択します。

データの表示

デフォルトでは、このページには次のデータが表示されます。

• ヘッダー領域
• メタデータ領域
• 関連リスト
• 概要パネル
• 使用法
• イベント
• セキュリティ
• 顧客間関係マップ

ヘッダー領域

API の名前、バージョン情報、API の現在のライフサイクルステージ (稼働中、提供終了など) が表示されます。

[表示方法] リストを使用すると、API を管理するさまざまな管理プラットフォーム (利用可能な場合) を切り替えることができます。

バージョンセレクターを使用すると、表示および管理する API のさまざまなバージョンを選択できます。[更新] を選択して、選択したバージョンに基づいて詳細を更新します。

注:

[表示方法] リストとバージョンセレクターは、API に適用可能な場合にのみ表示されます。

メタデータ領域

次のフィールドが表示されます。

フィールド	説明
説明	API の簡単な要約または目的。
最後の検出	CMDB 内で API が最後に検出または更新された日付。
ディスカバリーソース	API が検出されたソース。
タイプ	API のタイプ。スクリプト済み REST API、HTTP API、プラットフォーム REST API などです。
所有グループ	API の管理を担当するチームまたはグループ。
デジタルインターフェイス	システム内の API のインタラクションメソッド。

関連リスト

次のアイテムをカウントとリンクとして表示します。

アイテム	説明
受信したアクセス要求	API に対して行われたアクセス要求の数を表示します。カードに表示されているリンクを選択して、アクセス要求の詳細を表示します。
コンシューマー	API のコンシューマーの数を表示します。カードに表示されているリンクを選択すると、各 API コンシューマーの詳細が表示されます。
展開	環境全体での API のアクティブな展開、または過去の展開を示します。カードに表示されているリンクを選択して、API 展開の詳細を表示します。
製品	API に関連付けられている製品の数を表示します。カードに表示されているリンクを選択して、API 製品の詳細を表示します。
タグ	API に関連付けられたタグの数を表示します。カードに表示されているリンクを選択して、各タグの詳細を表示します。

概要パネル

API の使用可能なすべてのコンポーネントを、[概要] パネル内の 3 つのサブセクションにまとめて一覧表示します。

フロントエンド

GraphQL ミューテーションや、UI またはユーザー向け機能とやり取りするクエリなど、クライアント側の操作が含まれています。

バックエンド

バックエンド固有の GraphQL ミューテーションや、ビジネスロジックとデータを処理するクエリなど、サーバー側の操作が含まれています。

コンポーネント

さまざまな REST API エンドポイントまたはサービスインターフェイスが含まれ、それぞれが API 内で特定の機能またはリソースを提供します。

各サブセクションを展開してエンドポイントを表示し、任意のエンドポイントを選択してその詳細を表示できます。

使用状況

次のカードが表示されます。

カード	説明
平均要求数	経時的な API コンポーネント要求の数。線グラフで表され、X 軸は日付範囲、Y 軸は要求数を表します。
バージョン別の使用率	過去 10 日間における、さまざまなバージョン間の API 要求の分布。

イベント

次のカードが表示されます。

カード	説明
最重要のアラート	API に関連する IT 運用からの重大なアラートにより、API のパフォーマンスに影響を与える可能性のある重大な問題を特定できます。 カードを選択すると、 サービスオペレーションワークスペース 内のすべてのオープンアラートが表示され、それらに関する詳細情報にアクセスできます。詳細については、「Service Operations Workspace」を参照してください。
インシデント	機能停止、変更要求、API に関連する問題などの、記録されたインシデント。運用の健全性と修復作業の追跡に不可欠です。 カードを選択すると、 サービスオペレーションワークスペース 内のすべてのオープンインシデントが表示され、それらに関する詳細情報にアクセスできます。詳細については、「Service Operations Workspace」を参照してください。

セキュリティ

次のカードが表示されます。

カード	説明
アクティブな脆弱性一致アイテム	潜在的なリスクを追跡して解決することを可能にする API に関連付けられたセキュリティ脆弱性。 カードを選択すると、 脆弱性マネージャーワークスペース 内のすべての脆弱性が表示され、それらに関する詳細情報にアクセスできます。詳細については、「Vulnerability Manager Workspace」を参照してください。
セキュリティインシデント	セキュリティインシデントが有効になっている場合、API で発生した可能性のあるセキュリティ違反や問題に関するインサイトが提供されます。 カードを選択すると、 セキュリティインシデントレスポンスワークスペース 内のすべてのオープンセキュリティインシデントが表示され、それらに関する詳細情報にアクセスできます。詳細については、「Security Incident Response Workspace」を参照してください。

関係性マップ

コンポーネント、管理プラットフォーム、ビジネスアプリケーション、および設計との API 関係の階層的な概要を提供し、より広範なシステムアーキテクチャ内での API の役割を理解しやすくします。さらに、アプリケーションサービスの関係を管理するオプションも提供します。「API のアプリケーションサービス関係の管理」を参照してください。

顧客間関係マップは、CMDB ワークスペースで使用されているものと類似した部分的な統一マップです。API の統一マップを開くには、[API の詳細 (API details)] ページの [顧客間関係マップ (Relationship map)] セクションで [フルマップを開く (Open full map)] を選択します。詳細については、「統一マップ」を参照してください。

マップ上のノードは CMDB 内の API とそのコンポーネントを表し、線は API コンポーネント間の接続と関係を表します。接続は、たとえば、関係と参照を介して接続されているコンポーネントを表示することで、選択したノードに対する変更の影響を評価するのに役立ちます。Change Management、Incident Management、Event Managementなどの製品は、このような情報から恩恵を受けます。

このマップには、 Event Management や Incident Management などの製品で役立つアプリケーションサービスの構成も表示されます。変更履歴を確認することができます。

API の統一マップでは、次の要素を使用できます。

1：マップ

マップには、指定された API とその接続および関係が表示されます。この例では、httpbin.org-v1.1 がホームノードであり、線は他のコンポーネントとの接続および関係を表しています。任意のノードを選択すると、関連するアプリケーションサービスや変更履歴の詳細が表示されます。

2：コンテンツコントロール

• ホームノードを検索して選択し、表示するアプリケーションサービスの関係レベルの数を指定して、変更を加えた後にマップを再読み込みします。
• フィルターを使用して、マップ上に表示されるタイプと関係タイプを制限します。
• 選択した API のイベント (関連アイテム) のタイムラインを表示または非表示にします。

3：ツールボックス

ツールボックスを使用して、ズームレベルやレイアウトモードなど、マップのいくつかの視覚的な側面を制御します。

4：コンテキストサイドパネル

• [属性] パネル () には、選択した API または関係の場所や運用ステータスなどの属性が一覧表示されます。
• [アプリケーションサービス] パネル () には、選択した API に関連付けられているアプリケーションサービスの詳細が一覧表示されます。
• [関連アイテム] パネル ([) には、選択した API のアクティブなインシデントやアクティブな問題などの関連アイテムが表示されます。
• [変更] パネル () には、選択した API の運用ステータスの変更など、変更が一覧表示されます。

5：ミニマップナビゲーター

ズームレベルを設定するか、対象エリアにビューを移動します。アイコンを選択して、ナビゲーターを表示または非表示にします。

6：タイムライン

タイムラインは、指定された期間における選択した API のインシデント、問題、変更などのイベント (関連アイテム) を示します。タイムラインを使用して、API の変更履歴と、それらが CMDB のトポロジにどのように影響するかを可視化できます。