2.8.1 仮想マシンの一覧の取得
仮想マシンの一覧を取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/VirtualMachines
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。Collections
{ "data":["...", ...], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
anyType[] |
VirtualMachine のコレクション。 VirtualMachine の詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
pagination (Type: Pagination)
属性 |
データ型 |
説明 |
---|---|---|
page |
integer |
ページ |
pageSize |
integer |
ページサイズ |
numPages |
integer |
ページの数 |
totalCount |
integer |
オブジェクトの数 |
VirtualMachine
{ "instanceID":"...", "name":"...", "ipAddress":"...", "status":"...", "monitorStatus":"...", "description":"...", "collectorID":"...", "collectorName":"...", "autoCollectionType":"...", "clusterName":"...", "hypervisorType":"...", "hypervisorID":"...", "hypervisorName":"...", "hypervisorMonitorStatus":"...", "hostName":"...", "thresholdProfileID":"...", "thresholdProfileName":"...", "groupIDs":["...", ...], "groupNames":["...", ...], "gradeNames":["...", ...], "gradeOrders":["...", ...], "usedCredentialID":"...", "usedCredentials":"...", "accessPointType":"...", "accessPointIpAddress":"...", "accessPointUser":"..." }
VirtualMachine (Type: VirtualMachine)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
仮想マシンを特定するID |
name |
string |
仮想マシンの名称 |
ipAddress |
string |
仮想マシンのIPアドレス |
status |
enum |
仮想マシンの状態 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
monitorStatus |
enum |
仮想マシンの監視状態 (指定可能な値は「列挙型一覧」のComponentMonitorTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
description |
string |
仮想マシンの詳細情報。 |
collectorID |
long |
発見に使用されたコレクターを特定するID。 |
collectorName |
string |
発見に使用されたコレクターの名称。 |
autoCollectionType |
enum |
コレクターの定期実行の設定。 (指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
clusterName |
string |
仮想マシンが属するクラスタの名称 |
hypervisorType |
enum |
仮想マシンが属するハイパーバイザーの種別 (指定可能な値は「列挙型一覧」のArgusNodeTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
hypervisorID |
long |
仮想マシンが属するハイパーバイザーを特定するID |
hypervisorName |
string |
仮想マシンが属するハイパーバイザーの名称 |
hypervisorMonitorStatus |
enum |
仮想マシンが属するハイパーバイザーの監視状態 (指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
hostName |
string |
仮想マシン上で動作するOSのホスト名 |
thresholdProfileID |
long |
仮想マシンに割り当てられたしきい値プロファイルを特定するID |
thresholdProfileName |
string |
仮想マシンに割り当てられたしきい値プロファイルの名称 |
groupIDs |
long[] |
仮想マシンが割り当たっているコンシューマーを特定するID |
groupNames |
string[] |
仮想マシンが割り当たっているコンシューマーの名称 |
gradeNames |
string[] |
仮想マシンが割り当たっているコンシューマーのグレード |
gradeOrders |
integer[] |
仮想マシンが割り当たっているコンシューマーのグレードの優先度 |
usedCredentialID |
long |
発見時に使用された認証情報を特定するID。 |
usedCredentials |
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/VirtualMachines 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:50 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 7ca86aa5a44eb9b1c86c97c990674963cf98534d_WVlGcHsLfg5ffg0I_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "data" : [ { "instanceID" : 31, "name" : "vm017182", "ipAddress" : "172.17.17.182", "status" : "Normal", "monitorStatus" : "InUse", "description" : "vm017182 : 564d326f-e63b-1ec9-2cf0-7d1ae7755abe", "collectorID" : 0, "collectorName" : "172.17.17.115", "autoCollectionType" : "AutoConnect", "hypervisorType" : "SERVER_ESX", "hypervisorID" : 1, "hypervisorName" : "172.17.17.181", "hypervisorMonitorStatus" : "Manage", "hostName" : "vm017182", "thresholdProfileID" : 19, "thresholdProfileName" : "Default Profile for VM", "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "gradeNames" : [ "" ], "gradeOrders" : [ -1 ], "accessPointType" : "VCENTER", "accessPointIpAddress" : "172.17.17.115", "accessPointUser" : "Administrator" } ], "count" : 11 }