Hitachi

JP1 Version 11 JP1/Operations Analytics REST APIリファレンス


1.8.10 リソースの基本情報および性能情報をCSV形式で取得する

「対象リソースの基本情報」「対象リソースが持つ,各メトリックの性能情報(最新値)」および「対象リソースが持つ,特定のメトリックの性能情報(時系列)」をCSV出力するために使用する各リクエストの形式と,リクエストボディーで指定する内容について説明します。

背景

リソースの基本情報および性能情報は,段階的に取得します。取得の流れは以下のとおりです。

  1. リソースの一覧を取得するAPIを使用して,リソースのIDを取得します。

  2. リソース情報をCSV形式で取得するAPIを使用して,リソース情報を取得します。リクエストボディーには,手順1で取得したリソースのIDを指定します。

  3. リソースの性能情報(最新値)をCSV形式で取得するAPIを使用して,リソースの性能情報(最新値)を取得します。 リクエストボディーには,手順1または手順2で取得したリソースのIDを指定します。

  4. メトリックの性能情報(時系列)をCSV形式で取得するAPIを使用して,メトリックの性能情報(時系列)を取得します。リクエストボディーには,手順3で取得したメトリックのIDを指定します。

ここでは,ハイパーバイザー01のリソースであるCPU01の使用率を取得する例を使って手順を説明します。

操作手順

  1. ハイパーバイザーの一覧を取得して,CPU01を持つハイパーバイザー01のIDを取得します。次の形式でリクエストを発行します。

    GET http://host:port/Analytics/version/objects/Hypervisors

    次のとおり出力されたレスポンスボディーの中から,ハイパーバイザー01のIDが「4」であることを確認します。

    {
      "data" : [ {
        "instanceID" : 4,
        "name" : "hyperV",
        ...,
      }, ...
    }
  2. ハイパーバイザー01のIDをリクエストボディーに指定して,ハイパーバイザー01の情報を取得します。次の形式でリクエストを発行します。

    POST http://host:port/Analytics/version/services/E2EView/actions/getNodesDataCSV/invoke

    リクエストボディーの中で「parameters」のメンバーとして指定するオブジェクトは次のとおりです。

    表1‒23 リソースの基本情報の取得時に指定するメンバー

    メンバー

    指定可否

    説明

    basePointNodes

    必須

    nodeIDには手順1で取得したID「4」を,nodeTypeにはノードの種別を指定します。ノード種別として指定できる値は,「1.6 列挙型一覧」のE2ENodeTypeの表を参照してください。

    getType

    必須

    基本情報だけを取得する場合はBasicInformationを,関連情報も取得する場合はAllInformationを指定します。CPUやメモリ,NICなど各コンポーネントを取得したい場合はAllInformationを指定します。

    次のとおり出力されたレスポンスボディーの中から,CPU01のIDが「4」であることを確認します。

    {
      "instanceID" : "0052a2e2-713c-4cfb-892c-e9aaefb32b50",
      "created" : "2016-11-22T11:53:42.188+09:00",
      "updated" : "2016-11-22T11:53:42.354+09:00",
      "completed" : "2016-11-22T11:53:42.354+09:00",
      "state" : "success", 
      "affectedResource" : [ ],
      "result" : [ {
        "data": ""#JP1/Operations Analytics","111000","UTF-8 (BOM)"\n"#Resource Information"\n...",...,ResourceID,ResourceName,ResourceType,...,cpu4,CPU01,CPU,...,vm1,VM001,VM,...
      } ]
    }
  3. CPU01のIDをリクエストボディーに指定して,リソースの性能情報(最新値)を取得します。次の形式でリクエストを発行します。

    POST http://host:port/Analytics/version/services/PerfComponents/actions/getNodesGraphDataCSV/invoke

    リクエストボディーの中で「parameters」のメンバーとして指定するオブジェクトは次のとおりです。

    表1‒24 リソースの性能情報(最新値)の取得時に指定するメンバー

    メンバー

    指定可否

    説明

    basePointNodes

    必須

    nodeIDには,手順2で取得したID「4」を,nodeTypeにはノードの種別を指定します。ノード種別として指定できる値は,「1.6 列挙型一覧」のE2ENodeTypeの表を参照してください。

    baseTime

    任意

    性能情報を取得する基点の時刻。省略した場合は,APIを実行した時刻が基点として使用されます。

    次のとおり出力されたレスポンスボディーの中から,CPUの使用率を示すIDが「2」であることを確認します。

    {
      "instanceID" : "0052a2e2-713c-4cfb-892c-e9aaefb32b50",
      "created" : "2016-11-22T11:53:42.188+09:00",
      "updated" : "2016-11-22T11:53:42.354+09:00",
      "completed" : "2016-11-22T11:53:42.354+09:00",
      "state" : "success",
      "affectedResource" : [ ],
      "result" : [ {
        "data": ""#JP1/Operations Analytics","111000","UTF-8 (BOM)"\n"#Latest PerformanceInformation"\n...",...,Performance ID,...,1,...,2,...,3,...
      } ]
    }
    
  4. CPUの使用率を示すIDをリクエストボディーに指定して,リソースの性能情報(時系列)を取得します。次の形式でリクエストを発行します。

    POST http://host:port/Analytics/version/services/PerfComponents/actions/getNodesGraphDataCSV/invoke

    リクエストボディーの中で「parameters」のメンバーとして指定するオブジェクトは次のとおりです。

    表1‒25 リソースの性能情報(時系列)の取得時に指定するメンバー

    メンバー

    指定可否

    説明

    perfComponentIDs

    必須

    perfComponentIDsには手順3で取得したID「2」を指定します。

    baseTime

    任意

    性能情報を取得する基点の時刻。省略した場合は,APIを実行した時刻が基点として使用されます。

    pointTimeRange

    必須

    性能情報を取得する期間(ミリ秒)を指定します。

操作結果

手順2で「対象リソースの基本情報」,手順3で「対象リソースが持つ,各メトリックの性能情報(最新値)」,手順4で「対象リソースが持つ,特定のメトリックの性能情報(時系列)」がCSV形式で取得できます。