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

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

4.5 HTM - Agent for RAIDのインスタンス一覧の取得

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

HTTPリクエスト構文（URI）

GET  <scheme>://<host>:<port>/<application>/<version>/objects/AgentForRAID

リクエストの構造

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

レスポンスの構造

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

 
{
   "items":[{
     "instanceName":"...",
     "hostName":"...",
     "ipAddr":"...",
     "dataModelVersion":"...",
     "lastUpdateTime":"...",
     "storageVendor":"...",
     "storageModel":"...",
     "storageSerialNumber":"..."
            },
         :
         :
             ] 
}

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

表4-11 HTM - Agent for RAIDのインスタンスの一覧取得時のデータフォーマット

オブジェクト名 個数 説明
Collection 1 AgentForRAIDオブジェクトを子に持つCollectionオブジェクト
― AgentForRAID 0...n AgentForRAIDオブジェクト
AgentForRAIDオブジェクトのスキーマの詳細について，「表4-12 AgentForRAIDオブジェクトのスキーマ」に示します。

表4-12 AgentForRAIDオブジェクトのスキーマ

変数名 型 説明
instanceName string HTM - Agentsのインスタンス名。
hostName string HTM - Agentsが稼働しているホストの監視ホスト名。
ipAddr string HTM - Agentsが稼働しているホストのIPアドレス。
dataModelVersion decimal HTM - Agentsのデータモデルバージョン。
lastUpdateTime※1 string HTM - Agentsの情報の更新処理が成功した時刻。
ISO8601の拡張形式（YYYY-MM-DDThh:mm:ssZ）で表します。hhは24時間表記です。また，ZはUTC時刻であることを表します。
storageVendor※1 string ストレージシステム※2のベンダ名。
storageModel※1 string ストレージシステム※2のモデル名。
storageSerialNumber※1 string ストレージシステム※2の製造番号。

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

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

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

表4-13 HTM - Agent for RAIDのインスタンス一覧取得時のエラーレスポンス

エラー発生条件 HTTPレスポンス
ステータスコード Bodyに含まれるエラーID
内部エラーが発生しました。 500 KATR00101-E

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

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

curl -v -u system:manager -X GET https://server_1:22016/TuningManager/v1/objects/AgentForRAID

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

リクエストヘッダー：

GET /TuningManager/v1/objects/AgentForRAID HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.19.7 (i386-redhat-linux-gnu) libcurl/7.19.7 
NSS/3.12.9.0 zlib/1.2.3 libidn/1.18 libssh2/1.2.2
Host: server_1:22016
Accept: */*

レスポンスヘッダー：

HTTP/1.1 200 OK
Date: Fri, 20 Jun 2014 12:32:53 GMT
Server: Cosminexus HTTP Server
Last-Modified: Fri, 20 Jun 2014 12:32:14 GMT
Cache-Control: no-cache
Transfer-Encoding: chunked
Content-Type: application/json;charset=utf-8

レスポンスボディ：

{
   "items":[{
    "instanceName":"VSPG1000_instance",
    "hostName":"agent_1",
    "ipAddr":"<agent_1のIPアドレス>",
    "dataModelVersion":8.6,
    "storageVendor":"HITACHI",
    "storageModel":"VSP G1000",
    "storageSerialNumber":"10051",
    "lastUpdateTime":"2014-06-20T12:32:14Z"
           },
          {
    "instanceName":"USPV_instance",
    "hostName":"agent_2",
    "ipAddr":"<agent_2のIPアドレス>",
    "dataModelVersion":8.6,
    "storageVendor":"HITACHI",
    "storageModel":"USP V",
    "storageSerialNumber":"10007",
    "lastUpdateTime":"2014-06-20T12:32:14Z"
           },
        :
        :
          {
    "instanceName":"HUSVM_instance",
    "hostName":"agent_2",
    "ipAddr":"<agent_2のIPアドレス>",
    "dataModelVersion":8.6,
    "storageVendor":"HITACHI",
    "storageModel":"HUS VM",
    "storageSerialNumber":"210944",
    "lastUpdateTime":"2014-06-20T12:32:14Z"
           }]
}

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

[マニュアル発行元]

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