Hitachi

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


2.27.1 指定した性能情報の時系列での性能値をCSVで取得するために必要な情報の取得

指定した性能情報の時系列での性能値をCSVで取得するために必要な情報の取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/PerfComponents/actions/getGraphDataCSV

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。
{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "perfComponentIDs":["...", ...],
            "baseTime":"...",
            "pointTimeRange":"..."
        },
        :
        ]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

GetGraphDataCSVParam[]

操作実行時に必要なGetGraphDataCSVParamのコレクション。GetGraphDataCSVParamの詳細は以下の表を参照ください。

parameters (Type: GetGraphDataCSVParam)

属性

データ型

説明

perfComponentIDs

long[]

PerfComponentのID

baseTime

dateTime

性能情報を取得する基点の時刻。指定した時刻からpointTimeRangeで指定した期間さかのぼった時刻までの性能情報を取得します。省略した場合は,APIを実行した時刻が基点として使用されます。

pointTimeRange

long

性能情報を取得する期間 [ミリ秒]

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/PerfComponents/actions/getGraphDataCSV HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 03:10:45 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 60749ea2f05a1ff3a3db16f9af8ac3d45958a1_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "getGraphDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/PerfComponents/actions/getGraphDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "perfComponentIDs" : [ ],
    "baseTime" : "2019-09-12T12:10:45.435+09:00",
    "pointTimeRange" : 3600000
  } ]
}