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

概要

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

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

クライアントを認証するために、ソフトウェアメータリングAPIはベーシック認証を使用します。 Nexthinkは、APIのクライアントを専用に認証するためのローカルアカウントの作成を推奨します。

利用可能なメトリクスを見つける

APIを通じて利用可能なソフトウェアメータリングデータを対話的に探すには:

  1. 次のアドレスにwebブラウザをポイントします:

    https://<Portal_DNS_FQDN>/api/softwaremetering/v1​
    • <Portal_DNS_FQDN>をPortalの実際の名前に置き換えてください。

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

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

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

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

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

  5. 任意: 特定のプログラムに出力を制限するためにプログラムを選択します。

  6. 任意: 階層のノードに出力を制限するためにノード(パスの下)を選択します。 階層の各レベルに対して繰り返します。

  7. パッケージがインストールされているか、プログラムを使用中のエンティティのメトリクスの詳細を取得し、_format_にtable(HTMLテーブル用)、csv、またはjsonのいずれかを指定します。

    • インストール済み (フォーマット)

    • 使用中 (フォーマット)

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

APIのクエリ

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

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

メトリクス

希望するメトリクスのUID

(なし)

階層

階層の名前

Portalの最初の階層の名前

プログラム

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

(なし)

リスト

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

  • インストール済み

  • 使用中

インストール済み

パス

出力を制限するための階層内のノード名。 階層レベルを低下して出力をさらに制限するためにいくつかのパス要素を連鎖させます。

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

フォーマット

出力フォーマット、次のいずれか:

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

  • json

  • csv

テーブル

クエリURLの例:

https://<Portal_DNS_FQDN>/api/softwaremetering/v1/details?​
metric=52fa2b8b-b35e-4d7a-9db3-830617c5b6b2&​
hierarchy=DefaultHierarchy&​
program=8b37ddb4-29fe-469a-bdc0-ca3497d7c7f9&​
list=installed&​
path=Europe&path=Switzerland&path=Lausanne&​
format=json

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

curl https://<Portal_DNS_FQDN>/api/softwaremetering/v1/details?... -u username:password

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

APIの出力は、Portalで探索できるソフトウェアメータリングメトリクスの詳細と似ています。 ただし、APIにのみ存在するデータフィールドが2つあります:

  • エンティティ

  • パッケージを最初に検出した日

ソフトウェアメータリングAPIの出力の完全な一覧を以下に示します:

出力データ
説明

デバイス

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

エンティティ

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

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

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

1日あたりの平均実行回数

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

パッケージを最初に検出した日

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

最後の活動

デバイス上で最新に実行された重要なバイナリの最後の活動日。

バイナリ

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


関連するタスク

関連する参考文献

Last updated