2.3.1 コレクターの一覧の取得
JP1/OAが管理ソフトウェアの接続に使用するコレクターの一覧を取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/Collectors
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。Collections
{ "data":["...", ...], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
anyType[] |
Collector のコレクション。 Collector の詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
pagination (Type: Pagination)
属性 |
データ型 |
説明 |
---|---|---|
page |
integer |
ページ |
pageSize |
integer |
ページサイズ |
numPages |
integer |
ページの数 |
totalCount |
integer |
オブジェクトの数 |
Collector
{ "instanceID":"...", "name":"...", "collectorType":"...", "osType":"...", "autoCollectionType":"...", "connectResult":"...", "refreshStatus":"...", "message":"...", "lastRefreshed":"...", "refreshDateForInventory":"...", "refreshDateForPerformance":"...", "numOfHypervisors":"...", "numOfVms":"...", "numOfApplications":"...", "collectorCredentials":[{ "ipAddress":"...", "userId":"...", "portNumber":"...", "hypertextTransferProtocolType":"...", "domainName":"...", "useAdministrativeShares":"...", "shareName":"...", "sharedFolder":"...", "logicalHostName":"...", "useLogicalHostName":"..." }, : ], "productName":"...", "providerName":"...", "refreshDateForApp":"..." }
Collector (Type: Collector)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
インスタンスを特定するID |
name |
string |
コレクターの名称 |
collectorType |
enum |
コレクターの種別 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
osType |
enum |
コレクターのOS種別。コレクターの種別(collectorType)が「AJS」,「PFM」,「IM」の場合のみ指定します (指定可能な値は「列挙型一覧」のCollectorOsTypeの表を参照してください。) |
autoCollectionType |
enum |
コレクターの定期実行の設定 (指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
connectResult |
enum |
コレクター の最新の実行結果 (指定可能な値は「列挙型一覧」のConnectStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
refreshStatus |
enum |
コレクター の実行状態 (指定可能な値は「列挙型一覧」のConnectStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
message |
string |
コレクターの実行結果のメッセージ |
lastRefreshed |
dateTime |
最終リフレッシュ日時 |
refreshDateForInventory |
dateTime |
構成情報のリフレッシュ日時 |
refreshDateForPerformance |
dateTime |
性能情報のリフレッシュ日時 |
numOfHypervisors |
int |
コレクターにより発見されたハイパーバイザーの数 |
numOfVms |
int |
コレクターにより発見された仮想マシンの数 |
numOfApplications |
int |
コレクターにより発見されたアプリケーションの数 |
collectorCredentials |
CollectorCredential[] |
監視対象の接続に使用する認証情報 |
productName |
string |
収集対象製品名 |
providerName |
string |
コレクター作成者 |
refreshDateForApp |
dateTime |
定義反映日時 |
collectorCredentials (Type: CollectorCredential)
属性 |
データ型 |
説明 |
---|---|---|
ipAddress |
string |
管理ソフトウェアへの接続に使用するIPアドレスまたはホスト名 |
userId |
string |
管理ソフトウェアへの接続に使用するユーザーID。255byte以下の文字列を指定します。 |
portNumber |
int |
管理ソフトウェアへの接続に使用するポート番号。 |
hypertextTransferProtocolType |
enum |
管理ソフトウェアへの接続時にSSL(https)を使用するかどうか。 (指定可能な値は「列挙型一覧」のHypertextTransferProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
domainName |
string |
ドメイン名。アプリケーション連携でWindows選択時に使用。 |
useAdministrativeShares |
boolean |
管理共有を行う場合にtrueを設定する |
shareName |
string |
共有名 |
sharedFolder |
string |
共有フォルダのパス |
logicalHostName |
string |
論理ホスト名 |
useLogicalHostName |
boolean |
論理ホスト名を使用する場合にtrueに設定する |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
参照権限がない |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] GET /Analytics/v1/objects/Collectors HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: curl/7.33.0 Host: localhost:22015 Accept: application/json Accept-Language: ja [Response Header] HTTP/1.1 200 OK Date: Fri, 27 Nov 2015 05:21:49 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO b9719717b548c1da1798ed5a2b2c22dbda7f40cd_WVlGcHsLfg5ffg0I_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "data" : [ { "instanceID" : 0, "name" : "192.168.0.115", "collectorType" : "VCENTER", "autoCollectionType" : "AutoConnect", "connectResult" : "Succeeded", "refreshStatus" : "NoConnect", "lastRefreshed" : "2015-11-27T14:17:09.160+09:00", "refreshDateForInventory" : "2015-11-27T13:25:03.943+09:00", "refreshDateForPerformance" : "2015-11-27T14:17:09.160+09:00", "numOfHypervisors" : 2, "numOfVms" : 27, "numOfStorages" : 0, "collectorCredentials" : [ { "ipAddress" : "192.168.0.115", "userId" : "Administrator", "portNumber" : 443, "hypertextTransferProtocolType" : "HTTPS" } ] }, { "instanceID": 1, "name": "jp1ajs_v11", "collectorType": "AJS", "osType": "Windows", "autoCollectionType": "AutoConnect", "connectResult": "Succeeded", "refreshStatus": "NoConnect", "lastRefreshed": "2017-09-26T00:46:59.296+09:00", "refreshDateForInventory": "2017-09-26T00:46:59.296+09:00", "numOfHypervisors": 0, "numOfVms": 0, "numOfStorages": 0, "numOfApplications": 12, "collectorCredentials": [ { "ipAddress": "192.168.1.118", "userId": "administrator", "domainName": "", "useAdministrativeShares": true, "useLogicalHostName": false } ] }, { "instanceID": 3, "name": "customCollector", "collectorType": "CUSTOM_APP", "autoCollectionType": "AutoConnect", "connectResult": "Succeeded", "refreshStatus": "NoConnect", "lastRefreshed": "2017-09-26T10:15:26.991+09:00", "refreshDateForInventory": "2017-09-26T10:15:26.991+09:00", "numOfHypervisors": 0, "numOfVms": 0, "numOfStorages": 0, "numOfApplications": 10, "productName": "User Product", "providerName": "XXYY System", "refreshDateForApp": "2017-08-04T12:10:00.775+09:00" } ], "count" : 3 }