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

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

4.3 HTM - Agents一覧の手動リフレッシュ処理の実行

HTM - Agentsの一覧情報の手動リフレッシュは，HTM - Agentsで監視対象システムやインスタンス情報を変更した場合など構成変更したときには，パフォーマンスデータを取得する前に実行する必要があります。

HTM - Agentsの一覧情報を手動でリフレッシュする方法について示します。

HTTPリクエスト構文（URI）

POST <scheme>://<host>:<port>/<application>/<version>/services/AgentManager/actions/refresh/invoke

リクエストの構造

リクエストボディの構造を次に示します。

 
{
    "name"       : "RefreshAgentInstancesParameters", 
    "url"        : "<scheme>://<host>:<port>/<application>/<version>/
                   services/AgentManager/actions/refresh/invoke",
    "method"     : "POST",
    "type"       : "application/json", 
    "parameters" : [ { ... } ]
}

parametersに指定できる値について，次の表に示します。

表4-2 HTM - Agents一覧の手動リフレッシュ時のparameters

変数名 値 要素数 説明
parameters type string：変数の型を指します。 1 更新する対象のAgent 種別を定義します。
要素が2つ以上指定した場合，第2 要素以降は無視されます。
value 次の値のどれかでリフレッシュ対象を指定します。
  • All：Tuning Manager APIでの情報取得をサポートするすべてのエージェントを指します。
  • AgentForRAID：HTM - Agent for RAIDを指します。
  • AgentForNAS：HTM - Agent for NASを指します。

レスポンスの構造

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

 
{"status":"Completed"}

正常に更新処理が完了した場合は，レスポンスボディには次の表に示すJobオブジェクトを含みます。エラーが発生した場合は，発生した原因によってJobオブジェクトが含まれる場合と，Errorオブジェクトが含まれる場合があります。レスポンスボディがどちらのオブジェクトであるかはステータスコードで判別できます。

表4-3 Jobオブジェクトのスキーマ

変数名 型 説明
status string 処理結果の状態。
処理が正常に完了した場合は「Completed」，エラーが発生した場合は「Error」とします。
errorID string 発生したエラーを一意に識別できる識別子。
エラー発生時はログ出力のエラーIDと同じ値になります。なお，正常時にはこの変数は付与されません。
errorDescription string 発生したエラーの説明。
エラー発生時はログ出力と同じ文字列になります。また，文字列は英語で出力されます。なお，正常時にはこの変数は付与されません。

HTM - Agents一覧の手動リフレッシュ処理の実行で発生するエラー時のレスポンスについて次の表に示します。

表4-4 HTM - Agents一覧の手動リフレッシュ時のエラーレスポンス

エラー発生条件 HTTPレスポンス
ステータスコード Body
Errorオブジェクト Jobオブジェクト
messageID Status errorID
PFM - Managerが停止しています 200 － "Error" KATR11002-E
Actionオブジェクトのparametersの第1要素にサポート外のAgent種別が指定されました 400 KATR11032-E － －

（凡例）
－：該当なし

実行例

実行例1（すべてのエージェントの一覧をリフレッシュする場合）

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

curl -v -u system:manager -H "Content-Type: application/json" -H
"Content-Length: *" -H "Transfer-Encoding: chunked"  -X
POST https://server_1:22016/TuningManager/v1/services/AgentManager/actions/refresh/invoke -d
'{ "name" : "RefreshAgentInstancesParameters",
"url" : "https://server_1:22016/TuningManager/v1/services/AgentManager/actions/refresh/invoke",
"method" : "POST", "type" : "application/json",
"parameters" : [ { "type" : "string", "value" : "All" } ] }'

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

リクエストヘッダー：

POST /TuningManager/v1/services/AgentManager/actions/refresh/invoke 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: */*
Content-Type: application/json
Content-Length: *
Transfer-Encoding: chunked

レスポンスヘッダー：

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

レスポンスボディ：

{"status":"Completed"}

実行例2（HTM - Agent for RAIDの一覧をリフレッシュする場合）

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

curl -v -u system:manager -H "Content-Type: application/json" -H
"Content-Length: *" -H "Transfer-Encoding: chunked"  -X 
POST https://server_1:22016/TuningManager/v1/services/AgentManager/actions/refresh/invoke -d
'{ "name" : "RefreshAgentInstancesParameters",
"url" : "https://server_1:22016/TuningManager/v1/services/AgentManager/actions/refresh/invoke",
"method" : "POST", "type" : "application/json",
"parameters" : [ { "type" : "string", "value" : "AgentForRAID" } ] }'

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

リクエストヘッダー：

POST /TuningManager/v1/services/AgentManager/actions/refresh/invoke 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: */*
Content-Type: application/json
Content-Length: *
Transfer-Encoding: chunked

レスポンスヘッダー：

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

レスポンスボディ：

{"status":"Completed"}

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

[マニュアル発行元]

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