2.2.2 プラグインの情報取得
指定したプラグインの情報を取得します。
権限
Admin
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/Plugins/{id}
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "instanceID":"...", "name":"...", "pluginId":"...", "protocolType":"...", "formatversion":"...", "pluginversion":"...", "pluginType":"...", "numOfRelatedResources":"...", "isCollector":"...", "status":"..." }
Plugin (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の表を参照してください。) |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
参照権限がない |
404 |
Not Found |
リソースが存在しない |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] GET http://localhost:22015/Analytics/v1/objects/Plugins/0 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:33:31 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO e37f355445f0ffd3983bb9733cd5d3fed36d_Vlo8Y30JZAoRFn1MGwZuDwEDfF8=_V0810 X-Frame-Options: SAMEORIGIN x-xss-protection=1; mode=block X-Content-Type-Options=nosniff Keep-Alive: timeout=5, max=100 Connection: Keep-Alive Transfer-Encoding:chunked Content-Type: application/json [Response Body] { "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 }