Hitachi

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


2.16.2 指定したリソースの情報や関連するリソース一覧をCSVで取得

指定したリソースの情報や関連するリソース一覧をCSVで取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

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

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

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

parameters

anyType[]

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

GetNodesDataCSVParam

{
        "basePointNodes":[{
            "nodeID":"...",
            "nodeType":"..."
        },
        :
        ],
        "getType":"..."
}

GetNodesDataCSVParam (Type: GetNodesDataCSVParam)

属性

データ型

説明

basePointNodes

E2ENodeKey[]

ベースポイントとして指定する、取得対象のノードのリスト

getType

enum

取得する情報の区分

(指定可能な値は「列挙型一覧」のNodeInformationTypeの表を参照してください。)

basePointNodes (Type: E2ENodeKey)

属性

データ型

説明

nodeID

long

ノードのID

nodeType

enum

ノードの種別

(指定可能な値は「列挙型一覧」のE2ENodeTypeの表を参照してください。)

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

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

ログイン権限がない

412

Precondition Failed

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

・クエリパラメータしきい値超え

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST http://127.0.0.1:22015/Analytics/v1/services/E2EView/actions/getNodesDataCSV/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
  "basePointNodes": [{
      "nodeID": 1,
      "nodeType": "VIRTUAL_MACHINE"
    }],
  "selectedNodes": [{
      "nodeID": 1,
      "nodeType": "VIRTUAL_MACHINE"
    }],
  "highlightNodes": [{
      "nodeID": 1,
      "nodeType": "VIRTUAL_MACHINE"
    }],
  "getType": "AllInformation"
}

[Response Header]
HTTP/1.1 200 OK
Date: Tue, 22 Nov 2016 02:43:37 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 33659a74fcee4358dc272b34eca6ded1bf1131ec_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_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]
{
  "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..."
  } ]
}