2.18.1　ホストの一覧の取得

ホストの一覧を取得します。

権限

Admin, Modify

APIのバージョン

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Hosts

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "ipAddress":"...",
            "osType":"...",
            "status":"...",
            "monitorStatus":"...",
            "description":"...",
            "vmName":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "thresholdProfileID":"...",
            "thresholdProfileName":"...",
            "originalThresholdProfileID":"...",
            "groupIDs":["...", ...],
            "groupNames":["...", ...],
            "gradeNames":["...", ...],
            "gradeOrders":["...", ...],
            "deviceClassificationLabel":"...",
            "accessPointType":"...",
            "accessPointSnmpVersion":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"...",
            "pluginId":"...",
            "creatorType":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性	データ型	説明
data	Host[]	Hostのコレクション。Hostの詳細は以下の表を参照ください。
pagination	Pagination	ページ情報。リソースが存在しない場合、このパラメータは表示されません。
count	int	条件に合致したデータの個数

data (Type: Host)

属性	データ型	説明
instanceID	long	ホストを特定するID
name	string	ホストの名称
ipAddress	string	ホストのIPアドレス
osType	string	ホストのOS種別。以下の値のみ指定可能。・SERVER_WINDOWS:OSがWindowsである。・SERVER_LINUX:OSがLinuxである。・SERVER_SOLARIS:OSがSolarisである。・SERVER_HPUX:OSがHP-UXである。・SERVER_AIX:OSがAIXである。・GENERIC_COMPUTER:プラグインで収集されたホストである。・UNKNOWN:死活監視対象として収集されたホストまたは、管理対象として登録されたSNMPトラップ通知元ホスト。
status	enum	ホストの状態 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。 Normal Warning Error Unreachable Unknown NotMonitored
monitorStatus	enum	ホストの監視状態。 (指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。) 以下に示す値のみ指定可能です。 New Manage ignore MonitorOff
description	string	ホストの詳細情報
vmName	string	ホストが仮想マシン上で動作している場合の仮想マシン名。
usedCredentialID	long	発見時に使用された認証情報を特定するID。
usedCredentials	string	発見時に使用された認証情報の名称。
thresholdProfileID	long	ホストに割り当てられたしきい値プロファイルを特定するID
thresholdProfileName	string	ホストに割り当てられたしきい値プロファイルの名称
originalThresholdProfileID	string	ホストに割り当てられたしきい値プロファイルのオリジナルプロファイルID
groupIDs	long[]	ホストに割り当てられたコンシューマーを特定するID
groupNames	string[]	ホストに割り当てられたコンシューマーのグレード名称
gradeNames	string[]	ホストが割り当たっているコンシューマーのグレード
gradeOrders	integer[]	ホストが割り当たっているコンシューマーのグレードの優先度
deviceClassificationLabel	string	ホストに割り当てられた分類ラベル
accessPointType	enum	発見時に使用された認証情報の種別。 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。 WMI SSH SNMP
accessPointSnmpVersion	enum	認証情報のSNMPのバージョン (指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。) 以下に示す値のみ指定可能です。 V1_V2C V3
accessPointIpAddress	string	監視対象への接続に使用したIPアドレス
accessPointUser	string	監視対象への接続に使用したユーザーID
pluginId	string	ホストに適用されているプラグインのID
creatorType	enum	ホストが監視対象として追加された契機。ホストのosTypeが「UNKNOWN」の場合のみ有効です。 (指定可能な値は「列挙型一覧」のNodeCreatorTypeの表を参照してください。) 以下に示す値のみ指定可能です。 Discovery Trap

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 /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",
    "osType" : "SERVER_LINUX",
    "status" : "Unknown",
    "monitorStatus" : "Manage",
    "description" : "XXXX YYYY/ZZ Linux Server",
    "usedCredentialID" : 17,
    "usedCredentials" : "10.197.87.43",
    "thresholdProfileID" : 4,
    "thresholdProfileName" : "Default Profile for Linux/UNIX",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "deviceClassificationLabel":"Linux Development Env",
    "accessPointType" : "SSH",
    "accessPointIpAddress" : "10.197.87.43",
    "accessPointUser" : "root"
  }, {
    "instanceID" : 1,
    "name" : "10.197.199.44",
    "ipAddress" : "10.197.199.44",
    "osType" : "UNKNOWN",
    "status" : "NotMonitored",
    "monitorStatus" : "MonitorOff",
    "description" : "",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "deviceClassificationLabel" : "RPA system",
    "accessPointIpAddress" : "10.197.199.44",
    "creatorType" : "Discovery"
  } ],
  "count" : 2
}

2.18.1 ホストの一覧の取得

2.18.1　ホストの一覧の取得