2.16.1 ハイパーバイザーの一覧の取得
ハイパーバイザーの一覧を取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/Hypervisors
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "data":[{ "instanceID":"...", "name":"...", "ipAddress":"...", "status":"...", "monitorStatus":"...", "description":"...", "collectorID":"...", "collectorName":"...", "autoCollectionType":"...", "clusterName":"...", "clusterStatus":"...", "usedCredentialID":"...", "usedCredentials":"...", "hypervisorType":"...", "hypervisorDetailType":"...", "thresholdProfileID":"...", "thresholdProfileName":"...", "originalThresholdProfileID":"...", "accessPointType":"...", "accessPointSnmpVersion":"...", "accessPointIpAddress":"...", "accessPointUser":"...", "groupIDs":["...", ...], "groupNames":["...", ...], "gradeNames":["...", ...], "gradeOrders":["...", ...], "pluginId":"..." }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
Hypervisor[] |
Hypervisorのコレクション。Hypervisorの詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
data (Type: Hypervisor)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
ハイパーバイザーを特定するID |
name |
string |
ハイパーバイザーの名称 |
ipAddress |
string |
ハイパーバイザーのIPアドレス |
status |
enum |
ハイパーバイザーの状態 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
monitorStatus |
enum |
ハイパーバイザーの監視状態。 (指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
description |
string |
ハイパーバイザーの詳細情報 |
collectorID |
long |
発見に使用されたコレクターを特定するID。 |
collectorName |
string |
発見に使用されたコレクターの名称。 |
autoCollectionType |
enum |
コレクターの定期実行の設定。 (指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
clusterName |
string |
ハイパーバイザーが登録されているクラスタの名称 |
clusterStatus |
enum |
ハイパーバイザーが登録されているクラスタの状態 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
usedCredentialID |
long |
発見時に使用された認証情報を特定するID。 |
usedCredentials |
string |
発見時に使用された認証情報の名称。 |
hypervisorType |
string |
ハイパーバイザーの種別。以下の値のみ指定可能。 ・SERVER_ESX:ESXサーバ ・SERVER_HYPERV:Hyper-Vサーバ ・GENERIC_HYPERVISOR:プラグイン定義のハイパーバイザー |
hypervisorDetailType |
string |
プラグインにより定義されたハイパーバイザーの種別。 |
thresholdProfileID |
long |
ハイパーバイザーに割り当たっているしきい値プロファイルを特定するID |
thresholdProfileName |
string |
ハイパーバイザーに割り当たっているしきい値プロファイルの名称 |
originalThresholdProfileID |
string |
ハイパーバイザーに割り当てられたしきい値プロファイルのオリジナルプロファイルID |
accessPointType |
enum |
発見時に使用された認証情報のプロトコルまたはコレクターの種別。 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
accessPointSnmpVersion |
enum |
認証情報のSNMPのバージョン (指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。) 以下に示す値のみ指定可能です。
|
accessPointIpAddress |
string |
監視対象または管理ソフトウェアへの接続に使用したIPアドレスまたはホスト名 |
accessPointUser |
string |
監視対象または管理ソフトウェアへの接続に使用したユーザーID |
groupIDs |
long[] |
ハイパーバイザーが割り当たっているコンシューマーを特定するID |
groupNames |
string[] |
ハイパーバイザーが割り当たっているコンシューマーの名称 |
gradeNames |
string[] |
ハイパーバイザーが割り当たっているコンシューマーのグレード |
gradeOrders |
integer[] |
ハイパーバイザーが割り当たっているコンシューマーのグレードの優先度 |
pluginId |
string |
ハイパーバイザーに適用されているプラグインのID |
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/Hypervisors HTTP/1.1 Host: JP1OAServer:22015 User-Agent: curl/7.63.0 Content-Type: application/json Accept: application/json Authorization: Basic c3lzdGVtOm1hbmFnZXI= Accept-Language: ja [Response Header] HTTP/1.1 200 OK Date: Fri, 06 Sep 2019 09:40:40 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 6c538e8b65357bcc1674eef4d6cf6785014fca2_ZAlDSFUHGHp9UB8WcRQLdA==_V0810 X-Frame-Options: SAMEORIGIN X-XSS-Protection: 1; mode=block X-Content-Type-Options: nosniff Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "data" : [ { "instanceID" : 453, "name" : "10.197.64.51", "ipAddress" : "10.197.64.51", "status" : "Normal", "monitorStatus" : "Manage", "description" : "HITACHI BladeSymphony F51 ffff-1c6f653231d4", "collectorID" : 452, "collectorName" : "vCenterServer", "autoCollectionType" : "AutoConnect", "hypervisorType" : "SERVER_ESX", "thresholdProfileID" : 6, "thresholdProfileName" : "Default Profile for ESX", "accessPointType" : "VCENTER", "accessPointIpAddress" : "10.197.64.50", "accessPointUser" : "admin", "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "gradeNames" : [ "" ], "gradeOrders" : [ -1 ] }, { "instanceID" : 46, "name" : "10.197.64.62", "ipAddress" : "10.197.64.62", "status" : "Normal", "monitorStatus" : "Manage", "description" : "HITACHI HA8000/RS220 VMware ESXi ffffffff-ffff-ffff-ffff-1c6f65313f4e", "collectorID" : 452, "collectorName" : "vCenterServer", "autoCollectionType" : "AutoConnect", "hypervisorType" : "SERVER_ESX", "thresholdProfileID" : 6, "thresholdProfileName" : "Default Profile for ESX", "accessPointType" : "VCENTER", "accessPointIpAddress" : "10.197.64.50", "accessPointUser" : "admin", "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "gradeNames" : [ "" ], "gradeOrders" : [ -1 ] }, { "instanceID" : 450, "name" : "hyper-v", "ipAddress" : "10.197.64.136, 10.197.64.167", "status" : "NotMonitored", "monitorStatus" : "MonitorOff", "description" : "Hyper-V 48930542-9AA8-220C-5B04-4136724A2D79", "usedCredentialID" : 450, "usedCredentials" : "hyper-v-auth", "hypervisorType" : "SERVER_HYPERV", "thresholdProfileID" : 23, "thresholdProfileName" : "Default Profile for Hyper-V", "accessPointType" : "WMI", "accessPointIpAddress" : "10.197.64.131", "accessPointUser" : "administrator", "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "gradeNames" : [ "" ], "gradeOrders" : [ -1 ] }, { "instanceID" : 255, "name" : "esx2", "status" : "NotMonitored", "monitorStatus" : "MonitorOff", "description" : "Nutanix-1672e6be4fdfb05189fe6adf43858971a17d1b3d", "clusterName" : "HITACHI-NX", "usedCredentialID" : 300, "usedCredentials" : "hitachi nutanix", "hypervisorType" : "GENERIC_HYPERVISOR", "hypervisorDetailType" : "AHV", "accessPointType" : "SNMP", "accessPointSnmpVersion" : "V3", "accessPointIpAddress" : "10.197.64.111", "accessPointUser" : "admin", "groupIDs" : [ 160 ], "groupNames" : [ "Hitachi Cloud for JP1" ], "gradeNames" : [ "Platinum" ], "gradeOrders" : [ 0 ], "pluginId" : "com.hitachi.software.ias.NutanixPlugin" } ], "count" : 4 }