不一致 API 拡張クラス

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む5読むのに数分
  • CMDB CI Class Models ストアアプリは、不一致 API (application programming interface) のクラスを追加または更新します。

    このアプリは、クラスの説明、識別ルール、識別子エントリ、および依存関係 (該当する場合) を含む、CMDB クラス階層を拡張するクラスモデルを追加します。その後、追加したクラスを他の CMDB クラスと同じように使用できます。などの ディスカバリーとサービスマッピングパターン アプリケーションは、これらのクラス拡張を使用して CI を入力し、さまざまなテクノロジーやソフトウェアを検出できます。

    ストアでアプリを要求する

    ServiceNow Store Web サイトにアクセスして利用可能なすべてのアプリを表示し、ストアにリクエストを送信する方法について確認してください。リリースされたすべてのアプリのリリースノート情報については、「ServiceNow Storeバージョン履歴のリリースノート」を参照してください。

    不一致 API

    API [cmdb_ci_api] および API コンポーネント [cmdb_ci_api_component] クラスへの入力に適した構造になっていない API エンドポイントは、代わりに不一致 API エンドポイント [cmdb_ci_unmatched_api_endpoint] クラスに入力されます。不一致 API は通常、セキュリティスキャナーや観測可能性ツールなどの統合で使用されます。

    クラス

    このセクションでは、CMDB CI Class Models ストアアプリが追加または更新するクラスを一覧表示します。

    CMDB CI Class Models:リリース 1.49.0 では、一致しない API エンドポイントに対して次のクラスが追加されています。このストアアプリが拡張している可能性があるクラスを含む、ベースシステム内の CMDB クラスのリストについては、「CMDB テーブルの説明」を参照してください。

    クラス 拡張 説明
    不一致 API エンドポイント

    [cmdb_ci_unmatched_api_endpoint]

    構成アイテム

    cmdb_ci

    cmdb_ci_api または cmdb_ci_api_component を入力できない非構造化エンドポイントを持つ API。

    クラス属性

    CMDB CI Class Models:リリース 1.49.0 では、一致しない API エンドポイント [cmdb_ci_unmatched_api_endpoint] クラスに次の属性が追加されています。

    表 : 1. 不一致 API エンドポイント [cmdb_ci_unmatched_api_endpoint]
    属性 データタイプ 説明
    メソッド 文字列 API のバックエンドプロトコルタイプ。例:
    • Lambda
    • HTTP
    • 論理アプリ
    プロトコル 文字列 通信プロトコル。例:HTTP、HTTPS。
    URL 文字列 (1024) 呼び出されるリソースの URL。
    ID 文字列 (1024) ソースシステムからの一意の識別子。
    インターネットフェーシング ブーリアン コンポーネントがパブリックインターネットから到達可能かどうかを示すブール値。コンポーネントが到達可能な場合は 1 または「true」を指定します。
    認証 文字列 承認または認証方法のタイプ。例:
    • 基本
    • キー
    • OAuth
    • なし
    要求データタイプ 文字列 (255) 要求内のデータタイプのリスト。例:
    • CC
    • メール
    • アドレス
    応答データタイプ 文字列 (255) 応答内のデータタイプのリスト。例:
    • CC
    • メール
    • アドレス

    重要な関係構造

    一致しない API エンドポイント [cmdb_ci_unmatched_api_endpoint] CMDB クラスおよび API エンドポイント検出 [api_endpoint_discovered] 非 CMDB テーブルは、非構造化 API データが取り込まれ、IntegrationHub-ETL の機能を超えて処理する必要があるシナリオを対象としています。

    検出された API エンドポイント [api_endpoint_discovered] は、API [cmdb_ci_api] および API コンポーネント [cmdb_ci_api_component] クラスの生データのステージングテーブルとして機能します。適切に構造化されたデータソースから取得されていない、または標準の識別ルールを適用できない API データは、最初に API エンドポイント検出 [api_endpoint_discovered] テーブルに入力できます。その後、ユーザー定義の統合を使用して、API [cmdb_ci_api] および API コンポーネント [cmdb_ci_api_component] の品質と条件の要件に一致する整形式のデータが最も適切なテーブルに入力されるようにすることができます。

    データが正しく解析できない場合や、予期しない方法で構造化されている場合は、代わりに顧客定義の統合を使用して、一致しない API エンドポイント [cmdb_ci_unmatched_api_endpoint] テーブルに入力できます。

    API エンドポイント検出 [api_endpoint_discovered] テーブルに入力されたデータは、30 日ごとに消去されます。

    表 : 2. 検出された API エンドポイント [api_endpoint_discovered]
    属性 データタイプ 説明
    名前 文字列 (100) API エンドポイントの名前。
    メソッド 文字列 REST API のメソッド。例:
    • GET
    • POST
    • DELETE
    URL 文字列 (1024) 呼び出されるリソースの URL。
    タイプ 選択リスト API のタイプ。以下を指定できます。
    • REST
    • SOAP
    • HTTP
    • gRPC
    • GraphQL
    • Websocket
    認証 文字列 承認または認証方法のタイプ。例:
    • 基本
    • キー
    • OAuth
    • なし
    インターネットフェーシング ブーリアン コンポーネントがパブリックインターネットから到達可能かどうかを示すブール値。コンポーネントが到達可能な場合は 1 または「true」を指定します。
    要求データタイプ 文字列 (255) 要求内のデータタイプのリスト。例:
    • CC
    • メール
    • アドレス
    応答データタイプ 文字列 (255) 応答内のデータタイプのリスト。例:
    • CC
    • メール
    • アドレス
    ヘッダー 文字列 (255) ヘッダー名のカンマ区切りリスト。
    構成アイテム 参照 一致する CMDB CI (API コンポーネントまたは不一致 API エンドポイント) への参照。

    関連する非 CMDB テーブル

    一致しない API 拡張クラスは、API 展開 [api_deployment] 非 CMDB テーブルを関連リストとして使用します。

    表 : 3. API 展開 [api_deployment]
    属性 データタイプ 説明
    名前 文字列 (100) API 展開の名前。
    API 参照 展開済み API (cmdb_ci_api) への参照。
    不一致 API エンドポイント 参照 API が既存の API (cmdb_ci_unmatched_api_endpoint) と一致しない場合の、一致しない API エンドポイントへの参照。
    構成アイテム 参照 構成アイテムへの参照。API の展開先 CI が既知の場合、これは通常、手動で参照として指定されます。