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

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


5.7 メタ情報取得(パフォーマンスデータの取得の場合)

パフォーマンスデータリソースを除く,情報取得APIで使用するJSON Objectに関するメタ情報を取得する際に使用します。メタ情報はJSON Schemaに従って表現します。

なお,パフォーマンスデータリソースのメタ情報はCSVデータのヘッダーに付与して提供し,メタ情報だけでは取得できません。

HTTPリクエスト構文(URI)

GET  <scheme>://<host>:<port>/<application>/<version>/domain-types/<object-type>

補足
domain-typesドメインの下の<object-type>は,次の形式を指定してください。
  • Collectionオブジェクトのメタ情報を取得する場合:Collection
  • Errorオブジェクトのメタ情報を取得する場合:Error
  • Versionオブジェクトのメタ情報を取得する場合:Version
  • Actionオブジェクトのメタ情報を取得する場合:Action
  • Jobオブジェクトのメタ情報を取得する場合:Job
  • Agentsオブジェクトのメタ情報を取得する場合:Agents
  • AgentForRAIDオブジェクトのメタ情報を取得する場合:AgentForRAID

リクエストの構造

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

レスポンスの構造

スキーマは各オブジェクトを表すJSON Schemaに従います。

AgentForRAIDオブジェクトのメタ情報取得時のレスポンスボディの構造を次に示します。

{    "title" : "AgentForRAID",     "type" : "object",    "properties" : 
    {
        "instanceName"          : { "type" : "string" },
        "hostName"              : { "type" : "string" }, 
        "ipAddr"                : { "type" : "string" }, 
        "dataModelVersion"      : { "type" : "decimal"}, 
        "lastUpdateTime"        : { "type" : "string" }, 
        "storageVendor"         : { "type" : "string" }, 
        "storageModel"          : { "type" : "string" }, 
        "storageSerialNumber"   : { "type" : "string" }
   },
    "required" : [ "instanceName", "hostName" ]}

メタ情報取得で発生するエラー時のレスポンスについて次の表に示します。

表5-5 メタ情報取得時のエラーレスポンス

エラー発生条件 HTTPレスポンス
ステータスコード ヘッダー Bodyに含まれるエラーID
Name Value
存在しない,またはサポートしていないメタ情報の種別を指定しました。 404 追加されるヘッダーはありません。 KATR10045-E
内部矛盾が発生しました。 500 KATR00101-E
レスポンス返却中の内部エラーが発生しました。 レスポンスの返却を中止します。

実行例(AgentForRAIDオブジェクトのメタ情報取得)

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

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

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

リクエストヘッダー:

GET /TuningManager/v1/domain-types/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:37:25 GMT
Server: Cosminexus HTTP Server
Last-Modified: Thu, 29 May 2014 16:22:18 GMT
Cache-Control: private, max-age=86400
Transfer-Encoding: chunked
Content-Type: application/schema+json;charset=utf-8

レスポンスボディ:

{    "title" : "AgentForRAID",    "type" : "object",    "properties" :
    {
        "instanceName"          : { "type" : "string" },
        "hostName"              : { "type" : "string" },
        "ipAddr"                : { "type" : "string" }, 
        "dataModelVersion"      : { "type" : "decimal"},
        "lastUpdateTime"        : { "type" : "string" },
        "storageVendor"         : { "type" : "string" },
        "storageModel"          : { "type" : "string" },
        "storageSerialNumber"   : { "type" : "string" } 
   },
    "required" : [ "instanceName", "hostName" ]}

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


[マニュアル発行元]

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