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

3.8 HTM - Agents情報の更新

HTM - Agents情報を更新します。

HTTPリクエスト構文（URI）

PUT  <scheme>://<host>:<port>/<application>/<version>/services/agent-manager/actions/refresh/invoke

リクエストの構造

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

 
{
    "agentType" : "<エージェント種別>"
}

表3-8 情報の更新時のリクエストボディのスキーマ

変数名	型	指定要否	説明
agentType	string	必須	エージェント種別 HTM - Agent for RAIDの場合：raid HTM - Agent for NASの場合：nas すべてのエージェント種別の場合：all

レスポンスの構造

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

{
    "state": "...",
    "error": {
        "errorSource": "...",
        "message": "...",
        "messageID": "...",
        "actions": [
            "..."
        ]
    }
}

表3-9 情報の更新時のレスポンスボディのスキーマ

変数名		型	説明
state		string	処理結果の状態 Succeeded：成功 Failed：失敗
error※		―	エラー時の情報 詳細については，「2.7.2 Errorオブジェクト」を参照してください。
―	errorSource	string	APIクライアントが送信したURI
	message	string	エラーメッセージ
	messageID	string	メッセージID
	actions	string	APIクライアントが取るべき対処

注※

Succeededの場合は返却されません。

実行例（HTM - Agents情報の更新）

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

curl -v -H "Content-Type: application/json" -d '{"agentType":"all"}' -u system:manager -X PUT http://server_1:22015/DeviceManagerWebService/analytics/v1/services/agent-manager/actions/refresh/invoke

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

リクエストヘッダー：

PUT /DeviceManagerWebService/analytics/v1/services/agent-manager/actions/refresh/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.13.1.0 zlib/1.2.3 libidn/1.18 libssh2/1.2.2
Host: server_1:22015
Accept: */*
Content-Type: application/json
Content-Length: 19

レスポンスヘッダー：

HTTP/1.1 200 OK
Date: Tue, 20 Oct 2015 07:07:36 GMT
Server: Cosminexus HTTP Server
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8

レスポンスボディ：

{
    "state": "Succeeded"
}

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

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