software_instances REST API のマッピング関数

9.2.14 9.2.14 から使用可能です。software_instances REST API を使用するカスタム・ツールまたは内部プロセスがある場合は 、 v2/license_usage および v2/software_instances REST API を使用して目標を達成する方法を把握してください。バージョン 2 の REST API を使用するようにツールを調整することをお勧めします。

software_instances REST API 関数のマッピング

software_instances REST API を使用すると、レポート期間における製品によるライセンス・メトリックの使用状況のピークの原因となったソフトウェア・インスタンスに関する情報を取得できます。デフォルトでは、レポート期間は 90 日に設定されています。

v2/software_instances REST API を使用すると、ご使用の環境内のすべてのソフトウェア・インスタンスに関する情報を取得することができます。さらに、既存のコンポーネントの詳細、および削除されたコンポーネントに関する履歴データも含め、関連する任意の期間からデータを取得することができます。データをフィルタリングすることにより、製品によるライセンス・メトリックの使用状況のピークの原因となったインスタンスに結果を絞り込むことができます。v2/license_usage API と v2/software_instances API の関数を組み合わせることにより、旧バージョンの software_instances API のすべての関数を置き換えるだけでなく、照会の変更、必要なデータ・サンプルの取り出しといった柔軟な操作も保証されます。

例

シナリオ: 製品によるライセンス・メトリックの使用状況のピークの原因となったソフトウェア・インスタンスに関する情報を取得する

  • software_instances API を使用すると、レポート期間中に製品のライセンス・メトリックのピークに寄与したソフトウェア・インスタンスに関する情報のみを取得できます。
    図 1. software_instances REST API を使用して取得できるソフトウェア・インスタンス
    画面には、 software_instances REST API によって報告されたソフトウェア・インスタンスを表すグラフが表示されます。
  • v2/license_usage および v2/software_instances API を使用すると、以下の情報を取得できます。
    • 指定された期間内に使用されたすべてのソフトウェア・インスタンスのリスト
      図 2. v2/software_instances REST API を使用して取得できるソフトウェア・インスタンス
      v2/software_instances REST API
    • hwm_peak_time パラメーター値による、製品によるライセンス・メトリック使用状況のピーク時刻
    • ピークの原因となったソフトウェア・インスタンスのリスト
    • ピーク時における製品のライセンス・メトリックの全体的な使用状況
    製品によるライセンス・メトリックの使用状況のピークの原因となったソフトウェア・インスタンスに関する情報を取得するには、以下の手順を実行します。
    1. 特定の製品と、その製品に割り当てられているライセンス・メトリックについて、v2/license_usage REST API を実行します。

      例

      GET api/sam/v2/license_usage?columns[]=product_name&columns[]=metric_code_name&columns[]=hwm_quantity&
columns[]=hwm_peak_time&criteria={"and":[["product_name","=","IBM DB2 Advanced Enterprise Server Edition PVU Option"]]}
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
    2. 応答内の、製品とライセンスのペアの hwm_peak_time 列の値を確認します。

      例

      [{
"product_name": "IBM DB2 Advanced Enterprise Server Edition PVU Option",
"metric_code_name": "PVU_SUB_CAP",
"hwm_quantity": 960,
"hwm_peak_time": "2018-10-11T01:12:26Z"
}]
    3. 以下の列でフィルターを使用して、 v2/software_instances REST API を実行します。Discovery Start および Discovery End。hwm_peak_time の値に基づいて日付を指定します。

      例

      GET api/sam/v2/software_instances?columns[]=discovery_start&columns[]=discovery_end&columns[]=product_name&
columns[]=metric_id&columns[]=computer_name&criteria={"and":[["product_name","=
","IBM DB2 Advanced Enterprise Server Edition PVU Option"],["metric_id","=","5"],["discovery_start", "<=", "2018-10-11T01:12:26Z"], 
["discovery_end", ">", "2018-10-11T01:12:26Z"]]}&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
      注: この例では、PVU、RVP MPAC、および VPC メトリックに使用されるタイム・スタンプ形式を使用しています。他のメトリックについては、以下を参照してください:ソフトウェア・インベントリーの取得 (v2)。
    4. ピークの原因となったソフトウェア・インスタンスのリストの結果を確認します。