2.27.2 指定したリソースの情報や関連するリソース一覧をCSVで取得
指定したリソースの情報や関連するリソース一覧をCSVで取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
POST http[s]://host:port/Analytics/version/services/E2EView/actions/getNodesDataCSV/invoke
リクエストボディー
リクエストボディーの構造とオブジェクトの属性を次に示します。{ "name":"...", "href":"...", "method":"...", "type":"...", "parameters":[{ "basePointNodes":[{ "nodeID":"...", "nodeType":"..." }, : ], "getType":"..." }, : ] }
Action (Type: Action)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
操作名です。 |
href |
string |
操作の実行先URLです。 |
method |
string |
メソッド名です。 |
type |
string |
データのデータ形式です。 |
parameters |
GetNodesDataCSVParam[] |
操作実行時に必要なGetNodesDataCSVParamのコレクション。GetNodesDataCSVParamの詳細は以下の表を参照ください。 |
parameters (Type: GetNodesDataCSVParam)
属性 |
データ型 |
説明 |
---|---|---|
basePointNodes |
E2ENodeKey[] |
ベースポイントとして指定する、取得対象のノードのリスト |
getType |
enum |
取得する情報の区分 (指定可能な値は「列挙型一覧」のNodeInformationTypeの表を参照してください。) |
basePointNodes (Type: E2ENodeKey)
属性 |
データ型 |
説明 |
---|---|---|
nodeID |
long |
ノードのID |
nodeType |
enum |
ノードの種別 (指定可能な値は「列挙型一覧」のE2ENodeTypeの表を参照してください。) |
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "instanceID":"...", "created":"...", "updated":"...", "completed":"...", "state":"...", "affectedResource":["...", ...], "result":[{ "data":"..." }, : ] }
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 |
CsvData[] |
実行結果のCsvDataのコレクション。CsvDataの詳細は以下の表を参照ください。 |
result (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 /Analytics/v1/services/E2EView/actions/getNodesDataCSV/invoke HTTP/1.1 Host: JP1OAServer:22015 User-Agent: curl/7.63.0 Accept: application/json Accept-Language: ja Content-Type: application/json Authorization: Basic c3lzdGVtOm1hbmFnZXI= Content-Length: 330 [Request Body] { "name" : "getNodesDataCSV", "href" : "http://JP1OAServer:22015/Analytics/v1/services/E2EView/actions/getNodesDataCSV/invoke", "method" : "POST", "type" : "application/json", "parameters" : [ { "basePointNodes" : [ { "nodeID" : 17512, "nodeType" : "VIRTUAL_MACHINE" } ], "getType" : "AllInformation" } ] } [Response Header] HTTP/1.1 200 OK Date: Thu, 12 Sep 2019 04:27:21 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 4b39fb71c2514aca46ab8275c84e8dbd27788d_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] { "instanceID" : "b201975c-23b5-4d74-b807-09dcb59e11e6", "created" : "2019-09-12T13:27:21.864+09:00", "updated" : "2019-09-12T13:27:23.330+09:00", "completed" : "2019-09-12T13:27:23.330+09:00", "state" : "success", "affectedResource" : [ ], "result" : [ { "data" : "#JP1/Operations Analytics,121000,UTF-8 (BOM)\n#Resource Information\n#2019-09-12T13:27:22.389+0900\n............" } ] }