2.17.2 指定した性能情報の時系列での性能値をCSVで取得
指定した性能情報の時系列での性能値をCSVで取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
POST http[s]://host:port/Analytics/version/services/PerfComponents/actions/getGraphDataCSV/invoke
リクエストボディー
リクエストボディーの構造とオブジェクトの属性を次に示します。Action
{
"name":"...",
"href":"...",
"method":"...",
"type":"...",
"parameters":["...", ...]
}
Action (Type: Action)
|
属性 |
データ型 |
説明 |
|---|---|---|
|
name |
string |
操作名です。 |
|
href |
string |
操作の実行先URLです。 |
|
method |
string |
メソッド名です。 |
|
type |
string |
データのデータ形式です。 |
|
parameters |
anyType[] |
操作実行時に必要な GetGraphDataCSVParam のコレクション。 GetGraphDataCSVParam の詳細は以下の表を参照ください。 |
GetGraphDataCSVParam
{
"perfComponentIDs":["...", ...],
"baseTime":"...",
"pointTimeRange":"..."
}
GetGraphDataCSVParam (Type: GetGraphDataCSVParam)
|
属性 |
データ型 |
説明 |
|---|---|---|
|
perfComponentIDs |
long[] |
PerfComponentのID |
|
baseTime |
dateTime |
性能情報を取得する基点の時刻。指定した時刻からpointTimeRangeで指定した期間さかのぼった時刻までの性能情報を取得します。省略した場合は,APIを実行した時刻が基点として使用されます。 |
|
pointTimeRange |
long |
性能情報を取得する期間 [ミリ秒] |
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。Job
{
"instanceID":"...",
"created":"...",
"updated":"...",
"completed":"...",
"state":"...",
"affectedResource":["...", ...],
"result":["...", ...]
}
Job (Type: Job)
|
属性 |
データ型 |
説明 |
|---|---|---|
|
instanceID |
string |
インスタンスのIDを示します。 |
|
created |
string |
オブジェクトの生成日付を示します。ISO8601形式です。 |
|
updated |
string |
オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。 |
|
completed |
string |
処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。 |
|
state |
string |
以下の値が設定されます。 “failed”: 操作が正常終了しなかったことを示します。 “success”: 操作が正常終了したことを示します。 |
|
affectedResource |
string[] |
操作の結果,作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。 |
|
result |
anyType[] |
実行結果の CsvData のコレクション。 CsvData の詳細は以下の表を参照ください。 |
CsvData
{
"data":"..."
}
CsvData (Type: CsvData)
|
属性 |
データ型 |
説明 |
|---|---|---|
|
data |
string |
CSVデータが格納されます。 |
ステータスコード
|
HTTPステータスコード |
Reason phrase |
説明 |
|---|---|---|
|
200 |
OK |
正常終了 |
|
400 |
Bad Request |
リクエストボディ形式不正 |
|
401 |
Unauthorized |
ログイン権限がない |
|
403 |
Forbidden |
実行権限がない |
|
412 |
Precondition Failed |
サーバーが起動していない |
|
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header]
POST /Analytics/v1/services/PerfComponents/actions/getGraphDataCSV/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 296
[Request Body]
{
"name" : "getGraphDataCSV",
"href" : "http://localhost:22015/Analytics/v1/services/PerfComponents/actions/getGraphDataCSV/invoke",
"method" : "POST",
"type" : "application/json",
"parameters" : [ {
"perfComponentIDs" : [ ],
"baseTime" : "2016-11-25T11:11:04.489+09:00",
"pointTimeRange" : 86400000
} ]
}
[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json
[Response Body]
{
"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"#Time Series Performance Information"\n..."
} ]
}