ソフトウェアメータリングAPI (クラシック)

概要

外部システムとプログラム使用データを統合するために、ポータルはソフトウェアメータリングの履歴詳細ダッシュボードを照会するためのAPIを提供します。

ソフトウェアメータリングAPI のクライアントは、メインアプライアンス(ポータル)の証明書を信頼する必要があります。

クライアントを認証するために、ソフトウェアメータリングAPIは基本認証を使用します。 Nexthinkは、APIのクライアントを専用に認証するためのローカルアカウントを作成することをお勧めします。

利用可能なメトリクスを発見する方法

APIを通じて利用可能なソフトウェアメータリングデータをインタラクティブに検索するには:

  1. Webブラウザを以下のアドレスに向けます:

    https://<Portal_DNS_FQDN>/api/softwaremetering/v1​
    • <Portal_DNS_FQDN> をポータルの実際の名前に置き換えます。

  2. ソフトウェアメータリングAPIのディスカバリーツールに、ソフトウェアメータリングメトリクスを見る権利を持つユーザーとしてログインします(すべてのメトリクスを確認できるか、ユーザーの役割に関連するソフトウェアメータリングモジュールが含まれているため)。

    • Webブラウザから求められたらユーザーの資格情報を入力します。

    • ディスカバリーツールは、ユーザーのビューのドメインで利用可能なメトリクスのみを表示します。

  3. テーブルからメトリクスを選択します。

  4. 利用可能な階層を選択します。

  5. オプション: 出力を特定のプログラムに限定するためのプログラムを選択します。

  6. オプション: 出力をある階層のノードに限定するため、パスの下でノードを選択します。 階層の各レベルに対して繰り返します。

  7. エンティティがインストールされている場所やプログラムが使用中であるところのメトリクス詳細を取得し、format はテーブル(HTMLテーブル用)、csv、またはjsonのいずれかです:

    • インストール済み (format)

    • 使用中 (format)

目的のメトリクスの詳細に達したら、ディスカバリーツールが生成したURLをメモして、同じリクエストで後でAPIをプログラムでクエリするか、自分のリクエストのベースとして使用します。

APIをクエリします

ソフトウェアメータリングAPIをクエリするには、次のパラメータを含むURLにGETリクエストを送信します:

パラメータ
説明
デフォルト値

メトリック

希望のメトリクスのUID

(なし)

階層

階層の名前

ポータルの最初の階層名

プログラム

測定したいプログラムのUID(バイナリオブジェクト)

(なし)

リスト

出力にリストするタイプ:

  • インストール済み

  • 使用中

インストール済み

パス

出力を制限するための階層内のノードの名前。 階層レベルをさらに下げるために複数のパス要素を連結します。

ユーザのビューのドメインの最上位ノード

フォーマット

出力フォーマットの選択:

  • テーブル(HTMLテーブル用)

  • json

  • csv

areas

クエリURLの例:

ソフトウェアメータリングAPIは基本認証を使用します。 NexthinkアプライアンスからAPIをテストするには、curl を使用できます、例えば:

ソフトウェアメータリングAPIの出力

APIの出力は、ポータルで探索できるソフトウェアメータリングメトリクスの詳細に似ていますが、 二つのデータフィールドは、APIでのみ確認できます:

  • エンティティ

  • 最初のパッケージ使用日

以下はソフトウェアメータリングAPIの出力の完全なリストです:

出力データ
説明

デバイス

少なくとも1つのパッケージがインストールされているデバイスの名前。

エンティティ

デバイスが所属するエンティティの名前。

1日あたりの平均使用時間(秒)

デバイス上の重要なバイナリの1日あたりの平均使用時間を秒で示します。

1日あたりの平均実行数

デバイス上の重要なバイナリの1日あたりの平均実行数です。

最初のパッケージ使用日

デバイスで最も早く検出されたパッケージの最初の検出日。

最終活動日

デバイス上で最後に実行された重要なバイナリの最終活動日を示します。

バイナリ

デバイス上で使用されたバイナリを一覧表示します。 それは、使用されたバイナリのコレクション(_json_形式の出力)か、実際に使用された場合はyes、使用されなかった場合はnoと示された重要なバイナリのリスト(_テーブル_または_csv_形式の出力)です。


関連するタスク

関連する参照

Last updated

Was this helpful?