API 拡張クラス

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：8分

    • CMDB CI クラスモデルストアアプリは、API (application programming interface) のクラスを追加または更新します。

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

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

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

    API 一覧

    API は、コンピュータープログラムが相互に通信できるようにする一連の定義とプロトコルであり、アプリケーションソフトウェアをビルドまたは統合できるようにします。API は通常、Web ベースのテクノロジーを使用して他の API と通信します。API は通常、プログラムでジョブやタスクを実行したり、データを表示、インポート、エクスポート、削除、または変更したりするために使用されます。

    このリリースで追加されたクラスは、データモデルを拡張して API CI クラスの表現の基盤を提供します。この基盤を使用して、次のことができます。
    • API のヴィジビリティを向上させます。
    • API エンドポイントに関連するセキュリティの問題と脆弱性を特定します。

    クラス

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

    CMDB CI クラスモデル：リリース 1.49.0 では、API に次のクラスが追加されています。このストアアプリが拡張している可能性があるクラスを含む、ベースシステム内の CMDB クラスのリストについては、「CMDB テーブルの説明」を参照してください。

    クラス 拡張 説明
    API

    [cmdb_ci_api]

    		 構成アイテム

    cmdb_ci

    		 2 つのコンピュータープログラムが、通常は Web ベースのテクノロジーを使用して相互に通信できるようにする API。例：ChatAPI (https://[apiID].execute-api.use-east-2.amazonaws.com)。
    API コンポーネント

    [cmdb_ci_api_component]

    		 構成アイテム

    cmdb_ci

    		 機能やデータ交換を容易にする API 定義に関連する再利用可能なオブジェクト。例：GET https://[instance].service-now.com/api/now/table/{tablename}。
    API フロントエンド

    [cmdb_ci_api_frontend]

    		 API コンポーネント

    [cmdb_ci_api_component]

    		 クライアントまたはユーザーがやり取りまたは要求を行う API の部分。例：GET https://[apiID].execute-api.us-east-2.amazonaws.com/{proxy+}
    API バックエンド

    [cmdb_ci_api_backend]

    		 API コンポーネント

    [cmdb_ci_api_component]

    		 サーバーなどのバックエンドサービスとやり取りすることによって要求を満たす API の部分。例：Lambda:Chat-API-Proxy。
    API ゲートウェイ

    [cmdb_ci_api_gateway]

    		 アプリケーション

    [cmdb_ci_appl]

    		 クライアント API 要求を一元化し、バックエンドのプロセスとサービスを管理する API インフラストラクチャ。例：Kong ゲートウェイ。
    マネージド API

    [cmdb_ci_managed_api]

    		 構成アイテム

    [cmdb_ci_api]

    		 ゲートウェイまたは管理サービスから検出された API。このクラスの API のゲートウェイへの依存関係を適用できます。

    クラス属性

    CMDB CI クラスモデル：リリース 1.49.0 では、それぞれのクラスに次の属性が追加されています。

    表 : 1. API [cmdb_ci_api]
    属性 データタイプ 説明
    ベース URL 文字列 (1024) すべての API コンポーネントの拡張元となるベースアドレス。
    ID 文字列 (1024) ソースシステムからの一意の識別子。
    タイプ 選択リスト API のタイプ。以下を指定できます。
    • REST
    • SOAP
    • HTTP
    • gRPC
    • GraphQL
    • Websocket
    バージョン 数値 API のバージョン。
    仕様の場所 URL API 仕様の場所への URL。例：OpenAPI の仕様定義。
    表 : 2. API コンポーネント [cmdb_ci_api_component]
    属性 データタイプ 説明
    メソッド 文字列 REST API のメソッド。例：
    • GET
    • POST
    • DELETE
    プロトコル 文字列 通信プロトコル。例：HTTP、HTTPS。
    ホスト 文字列 (100) API をホストするシステム。
    パス 文字列 (1024) API がたどる特定のルート。
    ポート 文字列 通信ポート。例：80、443 など。
    URL 文字列 (1024) 呼び出されるリソースの URL。
    ID 文字列 (1024) ソースシステムからの一意の識別子。
    インターネットフェーシング ブーリアン コンポーネントがパブリックインターネットから到達可能かどうかを示すブール値。コンポーネントが到達可能な場合は 1 または「true」を指定します。
    認証 文字列 承認または認証方法のタイプ。例：
    • 基本
    • キー
    • OAuth
    • なし
    要求データタイプ 文字列 (255) 要求内のデータタイプのリスト。例：
    • CC
    • メール
    • アドレス
    応答データタイプ 文字列 (255) 応答内のデータタイプのリスト。例：
    • CC
    • メール
    • アドレス
    表 : 3. API フロントエンド [cmdb_ci_api_frontend]
    属性 データタイプ 説明
    親 ID 参照先 [cmdb_ci_api_frontend] 親 API コンポーネントへの参照。
    表 : 4. API バックエンド [cmdb_ci_api_backend]
    属性 データタイプ 説明
    タイプ 文字列 API のバックエンドプロトコルタイプ。例：
    • Lambda
    • HTTP
    • 論理アプリ
    表 : 5. API ゲートウェイ [cmdb_ci_cloud_gateway]
    属性 データタイプ 説明
    ID 文字列 (255) ソースシステムからの一意の識別子。
    注:
    マネージド API [cmdb_ci_managed_api] は、ゲートウェイおよびその他のマネージドサービスから検出された API に対して固有であり、現時点では新しい属性は導入されません。

    重要な関係構造

    API クラスと Kong クラスには、いくつかの重要な関係を定義する必要があります。

    表 : 6. API 関係
    親クラス 関係 子クラス 関係性タイプ
    API

    [cmdb_ci_api]

    		 Uses::Used by API コンポーネント

    [cmdb_ci_api_component]

    		 提案済み
    API ゲートウェイ

    [cmdb_ci_api_gateway]

    		 Provides::Provided By マネージド API

    [cmdb_ci_managed_api]

    		 依存
    API フロントエンド

    [cmdb_ci_api_frontend]

    		 Use End Point To::Use End Point From API バックエンド

    [cmdb_ci_api_backend]

    		 提案済み
    API バックエンド

    [cmdb_ci_api_backend]

    		 Uses::Used By Kong ロードバランサー

    [cmdb_ci_kong_lb]

    		 提案済み

    関連する非 CMDB テーブル

    CMDB CI クラスモデル v 1.49.0 では、非 CMDB テーブルが、次の API 拡張クラスの関連リストとして導入されています。

    API 関連リスト
    表 : 7. API 展開 [api_deployment]
    属性 データタイプ 説明
    名前 文字列 (100) API 展開の名前。
    API 参照 展開済み API (cmdb_ci_api) への参照。
    不一致 API エンドポイント 参照 API が既存の API と一致しない場合の、不一致 API エンドポイントへの参照 (cmdb_ci_unmatched_api_endpoint)。
    構成アイテム 参照 構成アイテムへの参照。API の展開先 CI が既知の場合、これは通常、手動で参照として指定されます。
    注:
    API 展開の非 CMDB テーブルは、API [cmdb_ci_api] クラスと不一致 API エンドポイント [cmdb_ci_unmatched_api_endpoint] クラスの両方に関連しています。
    API コンポーネント関連リスト
    表 : 8. API ヘッダー [api_header]
    属性 データタイプ 説明
    名前 文字列 (100) API ヘッダーの名前。
    API コンポーネント 参照 API ヘッダーが定義されているコンポーネントへの参照 (cmdb_ci_api_component)。
    不一致 API エンドポイント 参照 エンドポイントを既存の API またはコンポーネントと一致させることができない場合の、一致していない API への参照 (cmdb_ci_unmatched_endpoint)。
    API ゲートウェイ関連リスト
    表 : 9. API コンシューマー [api_consumer]
    属性 データタイプ 説明
    ユーザー名 文字列 (100) API コンシューマーの名前。
    ID 文字列 (255) ソースシステムからの一意の識別子。
    カスタム ID 文字列 (100) ユーザーの代替表示名。
    API ゲートウェイ 参照 コンシューマーが定義されているゲートウェイへの参照 (cmdb_ci_api_gateway)。
    表 : 10. API ポリシー [api_policy]
    属性 データタイプ 説明
    名前 文字列 (100) API ポリシーの名前。
    ID 文字列 (255) ソースシステムからの一意の識別子。
    フロントエンド 参照 API フロントエンド (cmdb_ci_api_frontend) への参照。
    マネージド API 参照 マネージド API (cmdb_ci_managed_api) への参照。
    コンシューマー 参照 API コンシューマー (api_consumer) の非 CMDB テーブルへの参照。
    プロトコル 文字列 この API ポリシーを適用できるプロトコルのアレイ。
    アクティブ ブーリアン この非 CMDB テーブルをアクティブと見なすか非アクティブと見なすかを決定します。
    API ゲートウェイ 参照 コンシューマーが定義されているゲートウェイへの参照 (cmdb_ci_api_gateway)。