2.9.1 ハイパーバイザーの一覧の取得
ハイパーバイザーの一覧を取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/Hypervisors
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。Collections
{
"data":["...", ...],
"pagination":{
"page":"...",
"pageSize":"...",
"numPages":"...",
"totalCount":"..."
},
"count":"..."
}
Collections (Type: Collections)
|
属性 |
データ型 |
説明 |
|---|---|---|
|
data |
anyType[] |
Hypervisor のコレクション。 Hypervisor の詳細は以下の表を参照ください。 |
|
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
|
count |
int |
条件に合致したデータの個数 |
pagination (Type: Pagination)
|
属性 |
データ型 |
説明 |
|---|---|---|
|
page |
integer |
ページ |
|
pageSize |
integer |
ページサイズ |
|
numPages |
integer |
ページの数 |
|
totalCount |
integer |
オブジェクトの数 |
Hypervisor
{
"instanceID":"...",
"name":"...",
"ipAddress":"...",
"status":"...",
"monitorStatus":"...",
"description":"...",
"collectorID":"...",
"collectorName":"...",
"autoCollectionType":"...",
"clusterName":"...",
"usedCredentialID":"...",
"usedCredentials":"...",
"hypervisorType":"...",
"thresholdProfileID":"...",
"thresholdProfileName":"...",
"accessPointType":"...",
"accessPointIpAddress":"...",
"accessPointUser":"...",
"groupIDs":["...", ...],
"groupNames":["...", ...],
"gradeNames":["...", ...],
"gradeOrders":["...", ...]
}
Hypervisor (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 |
ハイパーバイザーが登録されているクラスタの名称 |
|
usedCredentialID |
long |
発見時に使用された認証情報を特定するID。 |
|
usedCredentials |
string |
発見時に使用された認証情報の名称。 |
|
hypervisorType |
string |
ハイパーバイザーの種別。以下の値のみ指定可能。 ・SERVER_ESX:ESXサーバ ・SERVER_HYPERV:Hyper-Vサーバ |
|
thresholdProfileID |
long |
ハイパーバイザーに割り当たっているしきい値プロファイルを特定するID |
|
thresholdProfileName |
string |
ハイパーバイザーに割り当たっているしきい値プロファイルの名称 |
|
accessPointType |
enum |
発見時に使用された認証情報のプロトコルまたはコレクターの種別。 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
|
accessPointIpAddress |
string |
監視対象または管理ソフトウェアへの接続に使用したIPアドレスまたはホスト名 |
|
accessPointUser |
string |
監視対象または管理ソフトウェアへの接続に使用したユーザーID |
|
groupIDs |
long[] |
ハイパーバイザーが割り当たっているコンシューマーを特定するID |
|
groupNames |
string[] |
ハイパーバイザーが割り当たっているコンシューマーの名称 |
|
gradeNames |
string[] |
ハイパーバイザーが割り当たっているコンシューマーのグレード |
|
gradeOrders |
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
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 20: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" : 4,
"name" : "hyperV",
"ipAddress" : "10.197.87.56",
"status" : "Unknown",
"monitorStatus" : "Manage",
"description" : "Hyper-V 4C4C4544-0037-4710-8036-B7C04F504258",
"usedCredentialID" : 9,
"usedCredentials" : "10.197.87.56",
"hypervisorType" : "HYPERV",
"thresholdProfileID" : 23,
"thresholdProfileName" : "Default Profile for Hyper-V",
"accessPointType" : "WMI",
"accessPointIpAddress" : "10.197.87.56",
"accessPointUser" : "Administrator"
}, {
"instanceID" : 1,
"name" : "172.17.17.181",
"ipAddress" : "172.17.17.181",
"status" : "Normal",
"monitorStatus" : "Manage",
"description" : "ESX 42234bf5-2c85-4bd6-7452-5b235faae0d2",
"collectorID" : 0,
"collectorName" : "172.17.17.115",
"autoCollectionType" : "AutoConnect",
"hypervisorType" : "ESX",
"thresholdProfileID" : 6,
"thresholdProfileName" : "Default Profile for ESX",
"accessPointType" : "VCENTER",
"accessPointIpAddress" : "172.17.17.115",
"accessPointUser" : "Administrator"
} ], "count" : 2
}