2.17.1 仮想マシンの一覧の取得
仮想マシンの一覧を取得します。
本APIでは以下に示す通りオンデマンドで情報を取得することも可能です。
■概要
定期収集時に収集された情報ではなくAPI実行時の最新の情報を取得したい場合は,API実行時にvCenterから収集して返却するように変更出来ます。
■制限事項
・オンデマンドで情報が取得出来る仮想マシンはvCenterから取得するものに限ります。また,その際に取得出来る情報が限られます。取得出来る情報は後述のVirtualMachinesの表の中の以下の情報です。
- instanceID
- name
- ipAddress
- description
- clusterName
- hypervisorName
- hostName
・クエリパラメータの指定は出来ません。
■設定方法
マニュアルJP1/Operations Analytics 構築・運用ガイドのシステムプロパティファイル(Argus.properties)について説明している個所を参照してください。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/VirtualMachines
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "data":[{ "instanceID":"...", "name":"...", "ipAddress":"...", "status":"...", "monitorStatus":"...", "description":"...", "componentType":"...", "collectorID":"...", "collectorName":"...", "autoCollectionType":"...", "clusterName":"...", "hypervisorType":"...", "hypervisorDetailType":"...", "hypervisorID":"...", "hypervisorName":"...", "hypervisorMonitorStatus":"...", "hostName":"...", "thresholdProfileID":"...", "thresholdProfileName":"...", "originalThresholdProfileID":"...", "groupIDs":["...", ...], "groupNames":["...", ...], "gradeNames":["...", ...], "gradeOrders":["...", ...], "usedCredentialID":"...", "usedCredentials":"...", "accessPointType":"...", "accessPointSnmpVersion":"...", "accessPointIpAddress":"...", "accessPointUser":"...", "pluginId":"..." }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"...", "errorInfo":[{ "nodeName":"...", "message":"...", "messageID":"..." }, : ] }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
VirtualMachine[] |
VirtualMachineのコレクション。VirtualMachineの詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
errorInfo |
FailedNodes[] |
FailedNodesのコレクション。FailedNodesの詳細は以下の表を参照ください。 |
data (Type: VirtualMachine)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
仮想マシンを特定するID |
name |
string |
仮想マシンの名称 |
ipAddress |
string |
仮想マシンのIPアドレス |
status |
enum |
仮想マシンの状態 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
monitorStatus |
enum |
仮想マシンの監視状態 (指定可能な値は「列挙型一覧」のComponentMonitorTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
description |
string |
仮想マシンの詳細情報。 |
componentType |
enum |
仮想マシンの種別。 (指定可能な値は「列挙型一覧」のComponentTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
collectorID |
long |
発見に使用されたコレクターを特定するID。 |
collectorName |
string |
発見に使用されたコレクターの名称。 |
autoCollectionType |
enum |
コレクターの定期実行の設定。 (指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
clusterName |
string |
仮想マシンが属するクラスタの名称 |
hypervisorType |
enum |
仮想マシンが属するハイパーバイザーの種別 (指定可能な値は「列挙型一覧」のArgusNodeTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
hypervisorDetailType |
string |
仮想マシンが属するハイパーバイザーの詳細種別 |
hypervisorID |
long |
仮想マシンが属するハイパーバイザーを特定するID |
hypervisorName |
string |
仮想マシンが属するハイパーバイザーの名称 |
hypervisorMonitorStatus |
enum |
仮想マシンが属するハイパーバイザーの監視状態 (指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
hostName |
string |
仮想マシン上で動作するOSのホスト名 |
thresholdProfileID |
long |
仮想マシンに割り当てられたしきい値プロファイルを特定するID |
thresholdProfileName |
string |
仮想マシンに割り当てられたしきい値プロファイルの名称 |
originalThresholdProfileID |
string |
仮想マシンに割り当てられたしきい値プロファイルのオリジナルプロファイルID |
groupIDs |
long[] |
仮想マシンが割り当たっているコンシューマーを特定するID |
groupNames |
string[] |
仮想マシンが割り当たっているコンシューマーの名称 |
gradeNames |
string[] |
仮想マシンが割り当たっているコンシューマーのグレード |
gradeOrders |
integer[] |
仮想マシンが割り当たっているコンシューマーのグレードの優先度 |
usedCredentialID |
long |
発見時に使用された認証情報を特定するID。 |
usedCredentials |
string |
発見時に使用された認証情報の名称。 |
accessPointType |
enum |
発見時に使用された認証情報のプロトコルまたはコレクターの種別。 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
accessPointSnmpVersion |
enum |
認証情報のSNMPのバージョン (指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。) 以下に示す値のみ指定可能です。
|
accessPointIpAddress |
string |
監視対象または管理ソフトウェアへの接続に使用したIPアドレスまたはホスト名 |
accessPointUser |
string |
監視対象または管理ソフトウェアへの接続に使用したユーザーID |
pluginId |
string |
仮想マシンが属するハイパーバイザーに適用されているプラグインのID |
pagination (Type: Pagination)
属性 |
データ型 |
説明 |
---|---|---|
page |
integer |
ページ |
pageSize |
integer |
ページサイズ |
numPages |
integer |
ページの数 |
totalCount |
integer |
オブジェクトの数 |
errorInfo (Type: FailedNodes)
属性 |
データ型 |
説明 |
---|---|---|
nodeName |
string |
ノード名 |
message |
string |
メッセージ |
messageID |
string |
メッセージID |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
参照権限がない |
408 |
Request Timeout |
サーバーでの処理がタイムアウトした |
412 |
Precondition Failed |
・サーバーが起動していない (以下オンデマンドでの情報取得時のみ) ・vCenterサーバーとの接続に問題がある ・vCenterサーバーが正常に稼働していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] GET /Analytics/v1/objects/VirtualMachines 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:39:34 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO dac7fb616da3768ba63e98b322264fa36e708f_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" : 17319, "name" : "centOS", "ipAddress" : "", "status" : "NotMonitored", "monitorStatus" : "NotMonitored", "description" : "centOS : 90ED2A51-DFA0-4506-AB4F-CB3A4DC8C3D5", "componentType" : "VIRTUAL_MACHINE", "hypervisorType" : "SERVER_HYPERV", "hypervisorID" : 450, "hypervisorName" : "hyper-v", "hypervisorMonitorStatus" : "MonitorOff", "thresholdProfileID" : 19, "thresholdProfileName" : "Default Profile for VM", "originalThresholdProfileID": 19, "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "gradeNames" : [ "" ], "gradeOrders" : [ -1 ], "usedCredentialID" : 450, "usedCredentials" : "hyper-v-auth", "accessPointType" : "WMI", "accessPointIpAddress" : "10.197.64.10", "accessPointUser" : "administrator" } "instanceID" : 17218, "name" : "winsrv2012r2", "ipAddress" : "10.197.64.166", "status" : "Error", "monitorStatus" : "InUse", "description" : "winsrv2012r2 : 16A16D27-D419-45BC-AB42-B27CD28A0A20", "componentType" : "VIRTUAL_MACHINE", "hypervisorType" : "SERVER_HYPERV", "hypervisorID" : 450, "hypervisorName" : "hyper-v", "hypervisorMonitorStatus" : "MonitorOff", "hostName" : "WIN-KVR6P62HC7V", "thresholdProfileID" : 19, "thresholdProfileName" : "Default Profile for VM", "originalThresholdProfileID": 19, "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "gradeNames" : [ "" ], "gradeOrders" : [ -1 ], "usedCredentialID" : 450, "usedCredentials" : "hyper-v-auth", "accessPointType" : "WMI", "accessPointIpAddress" : "10.197.64.10", "accessPointUser" : "administrator" }, { "instanceID" : 17021, "name" : "dns-server", "status" : "Normal", "monitorStatus" : "InUse", "componentType" : "GENERIC_VIRTUALMACHINE", "clusterName" : "AHV-Cluster", "hypervisorType" : "GENERIC_HYPERVISOR", "hypervisorDetailType" : "AHV", "hypervisorID" : 251, "hypervisorName" : "NTNX-SGH823XYVL-A", "hypervisorMonitorStatus" : "MonitorOff", "hostName" : "49b57856-061a-4bd0-8d1e-08be03981299", "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "gradeNames" : [ "" ], "gradeOrders" : [ -1 ], "usedCredentialID" : 300, "usedCredentials" : "nutanix-credential", "accessPointType" : "SNMP", "accessPointSnmpVersion" : "V3", "accessPointIpAddress" : "10.197.64.111", "accessPointUser" : "admin", "pluginId" : "com.hitachi.software.ias.NutanixPlugin" }, { "instanceID" : 14541, "name" : "MONISRV", "ipAddress" : "", "status" : "Normal", "monitorStatus" : "InUse", "description" : "MONISRV : 4215f071-e007-48eb-0b25-2c1f7ea1f999", "componentType" : "VIRTUAL_MACHINE", "collectorID" : 452, "collectorName" : "vCenter_JP1OA", "autoCollectionType" : "AutoConnect", "hypervisorType" : "SERVER_ESX", "hypervisorID" : 43, "hypervisorName" : "10.197.64.31", "hypervisorMonitorStatus" : "Manage", "hostName" : "MONISRV", "thresholdProfileID" : 19, "thresholdProfileName" : "Default Profile for VM", "originalThresholdProfileID": 19, "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "gradeNames" : [ "" ], "gradeOrders" : [ -1 ], "accessPointType" : "VCENTER", "accessPointIpAddress" : "10.197.64.10", "accessPointUser" : "admin" } ], "count" : 4 }