API インサイトを使用した API データの監視と分析
API インサイトワークスペースの [概要] ページには、組織の API 状況の一元的な概要が表示されます。
API インサイト の概要ページにアクセスする
[概要] ページを開くには、 . デフォルトで [概要] ページが開きます。
必要なロール
- sn_api_insights_ws.api_mgmt_architect
- sn_api_insights_ws.api_mgmt_architect_admin
- sn_cmdb_admin注:sn_cmdb_admin ロールを持つユーザーが一部の機能やデータにアクセスするには、ml_report_user や cmdb_inst_admin などの追加のロールが必要です。
ユースケース
組織内のさまざまなユーザーがこのワークスペースをどのように使用するかの例については、次のユースケースを参照してください。
| ユーザー | ワークスペースの使用 |
|---|---|
| API インサイトアーキテクト | API を検索し、API の比較を行い、API へのアクセスを要求し、データの問題に対処します。 |
| API インサイトアーキテクトアドミニストレーター | API 作成ツール、ビジネスコンテキストの関係モデル、所有グループなどのAPI インサイト設定を管理します。 |
| CMDB アドミニストレーター | サービスグラフコネクタを使用して API データを CMDB にインポートするときに接続のエラーを表示して解決し、クラスタリングの推奨事項に基づいてデータを調整します。 |
機能
[概要] ページのさまざまなカードにアクセスして、組織で利用可能な API データに関するインサイトを取得します。
| 機能 | 説明 | 必要なロール |
|---|---|---|
| API を検索 | レビューまたは管理する特定の API を見つけるための組織内の API 検索。 |
|
| 受信したアクセス要求 | API アクセス管理の必要性を示す、受信したアクセス要求の数。 |
|
| アクセス 要求 | ログインユーザーによって作成されたアクセス要求の数。API アクセス管理のアクティビティを示します。 |
|
| 接続の概要 | 成功、失敗、または不明な接続テストの数、前回の実行でのデータインポートの成功率、現在データインポートを処理している接続の数など、 サービスグラフコネクタ を使用した API データ接続のステータスとアクティビティのサマリー。 | sn_cmdb_admin および cmdb_inst_admin |
| 構成の進捗状況の追跡 | サービスグラフコネクタの構成ステータスを監視する進行状況トラッカー。合計のうち正常に構成されたコネクタの数を示す半円形のゲージで可視化されます。 | sn_cmdb_admin および cmdb_inst_admin |
| 提案される API クラスタリング | データモデルの推奨事項設定に基づく、現在のクラスタリングの推奨事項を表す数値。「API インサイトでの API クラスタリングのデータモデル推奨事項の構成」を参照してください。 | sn_cmdb_admin および ml_report_user |
| 役に立つリソース | 追加のサポートと情報を得るための製品ドキュメント、ナレッジベース記事、コミュニティフォーラムへのリンク。 |
|
| 不足している API データ | ||
| ビジネスコンテキストがありません | ビジネスコンテキストがアサインされていない API の数。 |
|
| 不足している所有グループ | 所有グループがアサインされていない API の数。 所有グループにより、修復の追跡とアクセス要求の管理が可能になります。 |
|
| 不足している製品モデル | 製品モデルがアサインされていない API の数。 製品モデルを使用すると、正確なレポート作成と、バージョンアップされた複数の API とのやり取りが可能になります。 |
|
| デザインがありません | API 構成アイテム (CI) として利用可能で、設計表現のないランタイム API の数。 ランタイム API を、デジタルインターフェイスレコードとして使用できる設計時 API にリンクすると、使いやすさが向上します。 |
|
| チームの API | ||
| すべての API | チームによって管理される API の合計数。 |
|
| 設計中 | 現在設計中の API の数。 |
|
| Operational (稼働中) | 現在使用されている API の数。 |
|
| 終了 | 廃止された API の数。 |
|
| チームが管理する API | ||
| チームが管理するすべての API | 名前、コンシューマー数、管理プラットフォーム、ライフサイクルステージ、バージョン、1 分あたりの要求数などの詳細を含む、チームによって管理される API の概要。 |
|