2.10.1 ホストの一覧の取得
ホストの一覧を取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/Hosts
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。Collections
{ "data":["...", ...], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
anyType[] |
Host のコレクション。 Host の詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
pagination (Type: Pagination)
属性 |
データ型 |
説明 |
---|---|---|
page |
integer |
ページ |
pageSize |
integer |
ページサイズ |
numPages |
integer |
ページの数 |
totalCount |
integer |
オブジェクトの数 |
Host
{ "instanceID":"...", "name":"...", "ipAddress":"...", "osType":"...", "status":"...", "monitorStatus":"...", "description":"...", "vmName":"...", "usedCredentialID":"...", "usedCredentials":"...", "thresholdProfileID":"...", "thresholdProfileName":"...", "groupIDs":["...", ...], "groupNames":["...", ...], "deviceClassificationLabel":"...", "accessPointType":"...", "accessPointIpAddress":"...", "accessPointUser":"..." }
Host (Type: Host)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
ホストを特定するID |
name |
string |
ホストの名称 |
ipAddress |
string |
ホストのIPアドレス |
osType |
string |
ホストのOS種別。以下の値のみ指定可能。 ・SERVER_WINDOWS:OSがWindowsである。 ・SERVER_LINUX:OSがLinuxである。 ・SERVER_SOL:OSがSolarisである。 ・SERVER_HPUX:OSがHP-UXである。 ・SERVER_AIX:OSがAIXである。 |
status |
enum |
ホストの状態 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
monitorStatus |
enum |
ホストの監視状態。 (指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
description |
string |
ホストの詳細情報 |
vmName |
string |
ホストが仮想マシン上で動作している場合の仮想マシン名。 |
usedCredentialID |
long |
発見時に使用された認証情報を特定するID。 |
usedCredentials |
string |
発見時に使用された認証情報の名称。 |
thresholdProfileID |
long |
ホストに割り当てられたしきい値プロファイルを特定するID |
thresholdProfileName |
string |
ホストに割り当てられたしきい値プロファイルの名称 |
groupIDs |
long[] |
ホストに割り当てられたコンシューマーを特定するID |
groupNames |
string[] |
ホストに割り当てられたコンシューマーのグレード名称 |
deviceClassificationLabel |
string |
ホストに割り当てられた分類ラベル |
accessPointType |
enum |
発見時に使用された認証情報の種別。 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
accessPointIpAddress |
string |
監視対象への接続に使用したIPアドレス |
accessPointUser |
string |
監視対象への接続に使用したユーザーID |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
参照権限がない |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] GET /Analytics/v1/objects/Hosts 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 07:11:36 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 87d94e387ca516a82287ff4254ddac7f44e18bd4_WVlGcHsLfg5ffg0I_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "data" : [ { "instanceID" : 8, "name" : "fuji", "ipAddress" : "10.197.87.43", "status" : "Unknown", "osType" : "SERVER_LINUX", "monitorStatus" : "Manage", "description" : "XXXX YYYY/ZZ Linux Server", "deviceClassificationLabel":"Linux Development Env", "usedCredentialID" : 17, "usedCredentials" : "10.197.87.43", "thresholdProfileID" : 4, "thresholdProfileName" : "Default Profile for Linux/UNIX", "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "accessPointType" : "SSH", "accessPointIpAddress" : "10.197.87.43", "accessPointUser" : "root" } ], "count" : 1 }