API 拡張クラス

  • リリースバージョン: Zurich
  • 更新日 2025年08月07日
  • 所要時間：14分

    • CMDB CI クラスモデル ServiceNow Storeアプリは、API (アプリケーションプログラミングインターフェイス) のクラスを追加または更新します。

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

    すべての CMDB CI クラスモデル リリースの完全なリリースノートは、次の場所にあります。 https://www.servicenow.com/docs/bundle/store-release-notes/page/release-notes/store/it-operations-management/store-rn-itom-cmdb-class-models.html?emcs_t=S2h8ZW1haWx8Ym9hcmRfc3Vic2NyaXB0aW9ufE1FMlVTSFREVDc3S0hTfDMzNDcxMjV8U1VCU0NSSVBUSU9OU3xoSw

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

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

    API 一覧

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

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

    クラス

    このセクションでは、 CMDB CI クラスモデル ストアアプリが追加または更新するクラスを一覧表示します。 詳細については、 コミュニティの記事「API 用 CMDB の新しいデータモデル」を参照してください。

    CMDB CI クラスモデル:API の次のクラスが利用可能です。 このアプリが拡張する可能性のあるクラスを含む、 ベースシステム内のクラスのリストについては、「 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 定義に関連する再利用可能なオブジェクト。[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 の仕様定義。
    技術仕様の場所 文字列 API の技術仕様リポジトリの場所。例:展開された API コードを含む GitHub リポジトリ。
    設計仕様の場所 文字列 API 設計またはドキュメントの場所への URL。例:SwaggerHub API 設計仕様 URL。
    API [cmdb_ci_api] クラスは、タグとラベルのキー値 [cmdb_key_value] テーブルへのマッピングをサポートし、API メタデータのキーと値のストレージを有効にします。
    表 : 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
    • メール
    • 住所
    API コンポーネント [cmdb_ci_api_component] クラスは、タグとラベルのキー値 [cmdb_key_value] テーブルへのマッピングをサポートし、API コンポーネントメタデータのキーと値のストレージを有効にします。
    表 : 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 Gateway [cmdb_ci_api_gateway] クラスは、タグとラベルのキー値 [cmdb_key_value] テーブルへのマッピングをサポートしています。マッピングにより、API ゲートウェイメタデータのキー値ストレージが有効になります。
    API ゲートウェイでは、次のマーカークラスを使用できます。これらのクラスは、API Gateway [cmdb_ci_api_gateway] 親クラスからすべての属性を継承します。
    • Anypoint API Gateway [cmdb_ci_api_gateway_anypoint] (MuleSoft が提供)
    • Tyk API Gateway [cmdb_ci_api_gateway_tyk] (Tyk 提供)
    • Boomi API Gateway [cmdb_ci_api_gateway_boomi] (Boomi 提供)
    マーカークラスは既存のクラス構造に従い、 識別および調整エンジン (IRE) ルールを変更する必要はありません。
    注:
    マネージド API [cmdb_ci_managed_api] クラスは、ゲートウェイやその他のマネージド サービスから検出された API に固有であり、新しい属性は導入されません。
    API ゲートウェイおよび開発者ポータルでは、API 製品バンドルは、開発者とアプリケーションが使用する 1 つ以上の API のコレクションです。一部のプラットフォームでは、この用語を API プロダクトのみに使用します。
    表 : 6. API 製品バンドル [cmdb_ci_api_product_bundle]
    属性 データタイプ 説明
    ID 文字列 (255) API 製品バンドルの一意の識別子。
    検出された承認タイプ 文字列 ソースシステムから検出された要求承認のタイプ。
    検出されたアクセスタイプ 文字列 ソースシステムから検出されたアクセス構成。たとえば、公開や内部などです。
    作成日 日付/時刻 API 製品バンドルが最初に検出または記録された日時。
    最終変更日 日付/時刻 API 製品バンドルの最新の更新日時。
    検出された状況 文字列 ソースによって報告された製品バンドルの現在のステータス。たとえば、「公開済み」や「廃止」などです。
    1 つ以上の API 製品バンドルにアクセスするために、開発者は開発者ポータルで API コンシューマーサブスクリプションに登録できます。サブスクリプションは 1 つ以上のバンドルに登録され、バンドル内の API にアクセスするためのキーを提供します。
    表 : 7. API コンシューマーサブスクリプション [cmdb_ci_api_consumer_subscription]
    属性 データタイプ 説明
    検出された範囲 文字列 ソースシステムから検出されたアクセスの範囲。たとえば、すべての API または特定の API です。
    API コンシューマー 参照 API コンシューマーレコードへの参照。例:cmdb_ci_api_consumer。
    ID 文字列 (255) API コンシューマーサブスクリプションの一意の識別子。
    検出された状況 文字列 ソースシステムから検出されたサブスクリプションステータス。たとえば、アクティブまたは非アクティブです。
    作成日 日付/時刻 ソースシステムで API コンシューマーサブスクリプションが作成された日時。
    最終変更日 日付/時刻 API コンシューマーサブスクリプションの最新の更新日時。

    WebACL クラス [cmdb_ci_web_acl] は、CloudFront、API ゲートウェイ REST API、アプリケーションロードバランサー、AppSync GraphQL API、Cognito ユーザープール、App Runner サービス、AWS Verified Access、および Azure Front Door アプリケーションゲートウェイの ACL を表します。

    重要な関係構造

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

    表 : 8. 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]

    		 提案済み
    API ゲートウェイ

    [cmdb_ci_api_gateway]

    		 Provides::Provided By API 製品バンドル

    [cmdb_ci_api_product_bundle]

    		 依存
    API ゲートウェイ

    [cmdb_ci_api_gateway]

    		 Provides::Provided By API コンシューマーサブスクリプション

    [cmdb_ci_api_consumer_subscription]

    		 依存
    API 製品バンドル Contains::Contained by API

    [cmdb_ci_api]

    		 提案済み
    API 製品バンドル Used by::Uses API コンシューマーサブスクリプション

    [cmdb_ci_api_consumer_subscription]

    		 提案済み

    関連する非 CMDB テーブル

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

    API 関連リスト
    表 : 9. 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 コンポーネント関連リスト
    表 : 10. API ヘッダー [api_header]
    属性 データタイプ 説明
    名前 文字列 (100) API ヘッダーの名前。
    API コンポーネント 参照 API ヘッダーが定義されているコンポーネントへの参照 (cmdb_ci_api_component)。
    不一致 API エンドポイント 参照 エンドポイントを既存の API またはコンポーネントと一致させることができない場合の、一致していない API への参照 (cmdb_ci_unmatched_endpoint)。
    API ゲートウェイ関連リスト
    表 : 11. API コンシューマー [api_consumer]
    属性 データタイプ 説明
    ユーザー名 文字列 (100)

    API コンシューマーの名前。

    注:
    api_policyテーブルの [コンシューマー ] フィールドは参照フィールドです。[API ポリシー] リストの [ユーザー名] フィールドにユーザー名を表示するには、ユーザー名の display 属性を true に設定する必要があります。属性が true に設定されていない場合、リストには代わりにシステム ID が表示されます。
    ID 文字列 (255) ソースシステムからの一意の識別子。
    カスタム ID 文字列 (100) ユーザーの代替表示名。
    API ゲートウェイ 参照 コンシューマーが定義されているゲートウェイへの参照 (cmdb_ci_api_gateway)。
    API コンシューマータイプ 選択リスト API ユーザータイプ (user_type)。以下を指定できます。
    • 内部
    • 外部
    • 不明
    検出された状況 文字列 API コンシューマーのアカウントの現在のステータスを表します。
    プロバイダー 文字列 API コンシューマーの認証を担当する ID 管理プロバイダーの名前。
    Email 文字列 API コンシューマーのメールアドレス。
    登録日 日付/時刻 コンシューマーが提供プラットフォームに登録した日付。
    表 : 12. API コンシューマーアクセス [api_consumer_access]
    属性 データタイプ 説明
    API コンシューマー 参照 API コンシューマーレコードへの参照。例:cmdb_ci_api_consumer。
    API 参照 コンシューマーがアクセスを要求している API [cmdb_ci_api] への参照。
    認証方法 文字列 API コンシューマーが API にアクセスするために使用する認証方法。たとえば、API キーや OAuth などです。
    状況 選択肢 アクセスが現在アクティブか非アクティブかを示します。
    前回使用 日付/時刻 API コンシューマーが API にアクセスした最後の日時。
    有効期間終了日 日付/時刻 コンシューマーが API にアクセスできる有効期限。
    表 : 13. API ポリシー [api_policy]
    属性 データタイプ 説明
    名前 文字列 (100) API ポリシーの名前。
    ID 文字列 (255) ソースシステムからの一意の識別子。
    フロントエンド 参照 API フロントエンド (cmdb_ci_api_frontend) への参照。
    マネージド API 参照 マネージド API (cmdb_ci_managed_api) への参照。
    コンシューマー 参照 API コンシューマー (api_consumer) の非 CMDB テーブルへの参照。
    注:
    [コンシューマー ] は参照フィールドです。API ポリシーリストにapi_consumer (ユーザー名) を表示するには、api_consumer テーブルの [ユーザー名] フィールドの display 属性を true に設定する必要があります。属性が true に設定されていない場合、リストには代わりにシステム ID が表示されます。
    プロトコル 文字列 この API ポリシーを適用できるプロトコルのアレイ。
    アクティブ ブーリアン この非 CMDB テーブルをアクティブと見なすか非アクティブと見なすかを決定します。
    API ゲートウェイ 参照 コンシューマーが定義されているゲートウェイへの参照 (cmdb_ci_api_gateway)。