Tuning Manager APIリファレンスガイド

[目次][索引][前へ][次へ]

4.4 HTM - Agentsのインスタンス一覧の取得

HTM - Agentsのインスタンスの一覧を取得する方法について示します。

HTTPリクエスト構文（URI）

GET  <scheme>://<host>:<port>/<application>/<version>/objects/Agents?<query-string>

クエリ文字列

クエリ文字の指定例：

agentType=RAID

表4-5 HTM - Agentsのインスタンス一覧取得時に指定可能なクエリ文字列のキーと値

キー 値 指定要否
値域 概要
agentType 指定できる値を次に示します。
  • ALL：Tuning Manager APIでの情報取得をサポートするすべてのエージェントを指します。
  • RAID：HTM - Agent for RAIDを指します。
  • NAS：HTM - Agent for NASを指します。
 インスタンス一覧を取得したいHTM - AgentsのAgent種別 必須

リクエストの構造

リクエストボディは，空でなければいけません。

レスポンスの構造

レスポンスボディの構造を次に示します。

レスポンスボディに含むデータフォーマットを次の表に示します。

表4-6 HTM - Agentsのインスタンス一覧取得時のデータフォーマット

オブジェクト名 個数 説明
Collection 1 Agentsオブジェクトを子に持つCollectionオブジェクト
― Agents ― AgentForRAIDオブジェクトおよびAgentForNASオブジェクトの総称
― AgentForRAID 0...n AgentForRAIDオブジェクト
スキーマの詳細については「表4-7 Agentsオブジェクトのスキーマ」に示します。
AgentForNAS 0...n AgentForNASオブジェクト
スキーマの詳細については「表4-7 Agentsオブジェクトのスキーマ」に示します。

表4-7 Agentsオブジェクトのスキーマ

変数名 agentTypeおよびnasMonitoringTypeごとの表示の有無 型 説明
RAID NAS
Unified NAS External SMU VFP
agentType 　○　 　○　 　○　 　○　 string HTM - AgentsのAgent種別
instanceName 　○　 　○　 　○　 　○　 string HTM - Agentsのインスタンス名。
hostName 　○　 　○　 　○　 　○　 string HTM - Agentsが稼働しているホストの監視ホスト名。
ipAddr 　○　 　○　 　○　 　○　 string HTM - Agentsが稼働しているホストのIPアドレス。
dataModelVersion 　○　 　○　 　○　 　○　 decimal HTM - Agentsのデータモデルバージョン。
nasMonitoringType 　×　 　○※1 　○※1 　○※1 string NASシステムの種別。
  • 内部NAS Managerで管理されるNAS Platformの場合：Unified NAS
  • 外部NAS Managerで管理されるNAS Platformの場合：External SMU
  • Hitachi Virtual File Platformの場合：VFP
destIpAddr 　×　 　×　 　×　 　○※1 string NASシステムのIPアドレス。
なお，nasMonitoringTypeがnullの場合，この要素は表示されません。
detourIpAddr 　×　 　×　 　×　 　○※1 string NASシステムの予備のIPアドレス。
なお，nasMonitoringTypeがnullの場合，この要素は表示されません。
smuIpAddr 　×　 　×　 　○※2 　×　 string 外部NAS ManagerのIPアドレス。
なお，nasMonitoringTypeがnullの場合，この要素は表示されません。
svpIpAddr 　×　 　○※1 　×　 　×　 string NASモジュールを搭載したストレージシステムを管理しているSVPのIPアドレス。
なお，nasMonitoringTypeがnullの場合，この要素は表示されません。
storageVendor 　○※3 　×　 　×　 　×　 string ストレージシステム※4のベンダ名。
storageModel 　○※3 　○※1 　×　 　×　 string ストレージシステム※4のモデル名。
storageSerialNumber 　○※3 　○※1 　×　 　×　 string ストレージシステム※4の製造番号。
nasNodes 　×　 　○※5 　○※5 　×　 配列 nasNodes属性のスキーマについては，「表4-8 nasNodes属性のスキーマ」に示します。
なお，nasMonitoringTypeがnullの場合，この要素は表示されません。
nasClusters 　×　 　○※5 　○※5 　×　 配列 nasClusters属性のスキーマについては，「表4-9 nasClusters属性のスキーマ」に示します。
なお，nasMonitoringTypeがnullの場合，この要素は表示されません。
lastUpdateTime 　○※3 　○※5 　○※6 　○※7 string HTM - Agentsの情報の更新処理が成功した時刻。
ISO8601の拡張形式（YYYY-MM-DDThh:mm:ssZ）で表します。hhは24時間表記です。また，ZはUTC時刻であることを表します。

（凡例）
○：表示される
×：表示されない

注※1
次の場合はnullとなります。
  • インスタンスの設定に不正がある場合
  • インスタンスが起動していない状態でエージェント情報をリフレッシュした場合

注※2
次の場合はnullとなります。
  • インスタンスの設定に不正がある場合
  • PD_HSMUレコードが収集されていない，またはTuning Manager Agent REST API コンポーネントのサービス（Tuning Manager - Agent REST Web Service およびTuning Manager - Agent REST Application Service）が起動していない状態でエージェント情報をリフレッシュした場合

注※3
次の場合はnullとなります。
  • 監視対象ストレージシステムが存在しない場合
  • インスタンスの設定に不正がある場合
  • PDレコードまたはPD_PDXレコードが収集されていない状態でエージェント情報をリフレッシュした場合
  • 監視対象ストレージシステムがVSP Gx00モデル，VSP Fx00モデル，VSP E990，HUS VM，VSP 5000シリーズ，VSP G1000，G1500，VSP F1500，Virtual Storage Platformシリーズのときに，パフォーマンスデータの収集にコマンドデバイスを使用していない場合

注※4
監視対象ストレージシステムには仮想ストレージマシンは含まれません。

注※5
次の場合はnullとなります。
  • インスタンスの設定に不正がある場合
  • PD_HNCレコードが収集されていない，またはTuning Manager Agent REST API コンポーネントのサービス（Tuning Manager - Agent REST Web Service およびTuning Manager - Agent REST Application Service）が起動していない状態でエージェント情報をリフレッシュした場合

注※6
次の場合はnullとなります。
  • インスタンスの設定に不正がある場合
  • PD_HSMUレコードおよびPD_HNCレコードが収集されていない，またはTuning Manager Agent REST API コンポーネントのサービス（Tuning Manager - Agent REST Web Service およびTuning Manager - Agent REST Application Service）が起動していない状態でエージェント情報をリフレッシュした場合

注※7
次の場合はnullとなります。
  • インスタンスの設定に不正がある場合
  • インスタンスが起動していない，PD_CPCレコードが収集されていない，またはTuning Manager Agent REST API コンポーネントのサービス（Tuning Manager - Agent REST Web Service およびTuning Manager - Agent REST Application Service）が起動していない状態でエージェント情報をリフレッシュした場合

表4-8 nasNodes属性のスキーマ

変数名 型 説明
nodeName string 監視対象ノードのノード名。
nodeUuid string 監視対象ノードのUUID。
非クラスタノードの場合だけ表示されます。
clusterUuid string 監視対象ノードが属するクラスタのUUID。
クラスタ構成のノードの場合だけ表示されます。

表4-9 nasClusters属性のスキーマ

変数名 型 説明
clusterName string 監視対象クラスタのクラスタ名。
clusterUuid string 監視対象クラスタのUUID。

HTM - Agentsのインスタンス一覧取得で発生するエラー時のレスポンスについて次の表に示します。

表4-10 HTM - Agentsのインスタンス一覧取得時のエラーレスポンス

エラー発生条件 HTTPレスポンス
ステータスコード Bodyに含まれるエラーID
「agentType」をクエリで指定していません。 400 KATR11037-E
「agentType=」の値に不正なAgent種別を指定しています。 400 KATR11038-E
内部エラーが発生しました。 500 KATR00101-E

実行例（HTM - Agentsのインスタンス一覧の取得）

curlコマンドを使用したリクエストメッセージ：

curl -v -u system:manager -H Content-Type: application/json -X GET http://server_1:22015/TuningManager/v1/objects/Agents?agentType=ALL

リクエストに対する実行結果／

リクエストヘッダー：

GET /TuningManager/v1/objects/Agents?agentType=ALL HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7
NSS/3.18 Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2
Host: server_1:22015
Host: :22016
Accept: */*
Content-Type: application/json

レスポンスヘッダー：

HTTP/1.1 200 OK
Date: Mon, 28 Sep 2015 06:41:14 GMT
Server: Cosminexus HTTP Server
Last-Modified: Mon, 28 Sep 2015 06:41:03 GMT
Cache-Control: no-cache
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json;charset=utf-8

レスポンスボディ：

{
    "items":[{
    "agentType":"RAID",
    "instanceName":"MONITOR1",
    "hostName":"esxi4VM02",
    "ipAddr":"<MONITOR1のIPアドレス>",
    "dataModelVersion":9.0,
    "storageVendor":"HITACHI",
    "storageModel":"HUS110",
    "storageSerialNumber":"91210942",
    "lastUpdateTime":"2015-09-09T04:47:16Z"
           },
           {
    "agentType":"NAS",
    "instanceName":"MONITOR1",
    "hostName":"esxi4VM02",
    "ipAddr":"<MONITOR1のIPアドレス>",
    "dataModelVersion":6.6,
    "nasMonitoringType":VFP,
    "destIpAddr":"<監視対象NASシステムのIPアドレス>",
    "detourIpAddr":"",
    "lastUpdateTime":"2015-09-09T04:47:16Z"
            }]
}

[目次] [前へ] [次へ]

[マニュアル発行元]

All Rights Reserved. Copyright© 2014, 2020, Hitachi, Ltd.