2.2.1 プラグイン情報の一覧の取得
JP1/OAに登録されているプラグイン情報の一覧を取得します。
権限
Admin
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/Plugins
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "data":[{ "instanceID":"...", "name":"...", "pluginId":"...", "protocolType":"...", "formatversion":"...", "pluginversion":"...", "pluginType":"...", "numOfRelatedResources":"...", "isCollector":"...", "status":"..." }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
Plugin[] |
Pluginのコレクション。Pluginの詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
data (Type: Plugin)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
インスタンスを特定するID |
name |
string |
プラグインの名称 |
pluginId |
string |
プラグインを特定するID |
protocolType |
enum |
監視対象への接続に使用するプロトコル (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
formatversion |
string |
プラグインのフォーマットバージョン |
pluginversion |
string |
プラグインのバージョン |
pluginType |
enum |
プラグインの種別 (指定可能な値は「列挙型一覧」のPluginTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
numOfRelatedResources |
int |
プラグイン情報を用いて発見されたリソースの数 |
isCollector |
boolean |
コレクターであるかどうか。 |
status |
enum |
プラグインの状態 (指定可能な値は「列挙型一覧」のPluginStatusTypeの表を参照してください。) |
pagination (Type: Pagination)
属性 |
データ型 |
説明 |
---|---|---|
page |
integer |
ページ |
pageSize |
integer |
ページサイズ |
numPages |
integer |
ページの数 |
totalCount |
integer |
オブジェクトの数 |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
参照権限がない |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] GET http://localhost:22015/Analytics/v1/objects/Plugins HTTP/1.1 Host: localhost:22015 User-Agent: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:52.0) Gecko/20100101 Firefox/52.0 Accept: application/json Accept-Language: ja Content-Type: application/json Authorization: Basic c3lzdGVtOm1hbmFnZXI= [Response Header] HTTP/1.1 200 OK Date: Thu, 02 Aug 2018 05:26:16 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 62acd5efafe957ae5bcf4a65265bae4ebf8b0b1_Vlo8Y30JZAoRFn1MGwZuDwEDfF8=_V0810 X-Frame-Options: SAMEORIGIN Keep-Alive: timeout=5, max=100 Connection: Keep-Alive Content-Type: application/json [Response Body] { "data": [ { "instanceID": 50, "name": "Sample 002 SNMP Node Plugin", "pluginId": "com.hitachi.software.ias.sample002", "protocolType": "SNMP", "formatversion": "0001", "pluginversion": "0001", "pluginType": "NODE_PLUGIN", "numOfRelatedResources": 2, "isCollector": false, "status": "ACTIVE" }, { "instanceID": 0, "name": "Sample 001 SNMP Node Plugin", "pluginId": "com.hitachi.software.ias.sample001", "protocolType": "SNMP", "formatversion": "0001", "pluginversion": "0001", "pluginType": "NODE_PLUGIN", "numOfRelatedResources": 1, "isCollector": false, "status": "ACTIVE" } ], "count": 2 }