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

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

3.6 アラート定義情報の同期

Device ManagerホストとHTM - Agentsホストのアラート定義情報を同期します。Device Managerが管理しているアラート定義情報とHTM - Agentsが管理しているアラート定義情報を一致させます。

HTTPリクエスト構文（URI）

PUT  <scheme>://<host>:<port>/<application>/<version>/services/alert-def-manager/actions/sync/invoke

リクエストの構造

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

 
{
    "agentType" : "<エージェント種別>",
    "hostName" : "<ホスト名>",
    "instanceName" : "<インスタンス名>"
}

表3-6 アラート定義同期時のリクエストボディのスキーマ

変数名 型 指定要否 説明
agentType string 必須 エージェント種別
  • HTM - Agent for RAIDの場合：raid
  • HTM - Agent for NASの場合：nas
  • すべてのエージェント種別の場合：all
hostName string 任意 エージェントのホスト名
省略した場合は，すべてのホストが対象となります。
instanceName string 任意 エージェントインスタンス名
省略した場合はすべてのエージェントインスタンスが対象となります。

レスポンスの構造

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

{
    "state": "...",
    "error": {
        "errorSource": "...",
        "message": "...",
        "messageID": "...",
        "actions": [
            "..."
        ]
    },
    "result": [
        {
            "syncResult": "...",
            "agent": {
                "agentType": "...",
                "hostName": "...",
                "instanceName": "...",
                "model": "...",
                "serialNumber": "...",
                "smuIp":"...",
                "destIp":"...",
                "detourIp":"..."
            },
            "syncedAlertDef": [
                "...",
                "...",
                   :
            ]
        },
                   :
    ],
    "resultType": "AlertDefSyncResult"
}

表3-7 アラート定義同期時のレスポンスボディのスキーマ

変数名 型 説明
state string 処理結果の状態
  • Succeeded：成功
  • Failed：失敗
  • Distribution Failed：失敗（エージェントとの同期）
    Distribution Failedの場合，返却されたcause要素の内容を確認して，失敗の要因を取り除いてから，アラート定義情報の同期を実行してください。
error※1 ― エラー時の情報
詳細については，「2.7.2 Errorオブジェクト」を参照してください。
― errorSource string APIクライアントが送信したURI
message string エラーメッセージ
messageID string メッセージID
actions string型の配列 APIクライアントが取るべき対処
result ― 定義同期の結果情報
― syncResult string 同期の状態
  • Succeeded：成功
  • Failed：失敗
agent ― 監視対象の情報
― agentType string エージェントの種別
  • HTM - Agent for RAIDの場合：RAID
  • HTM - Agent for NASの場合：NAS
hostName string エージェントのホスト名
instanceName string エージェントのインスタンス名
model string ストレージシステムの機種名
serialNumber string ストレージシステムのシリアル番号
smuIp string 外部NAS Managerを特定するための情報
外部NAS Managerで管理されるNAS Platformのインスタンスを作成するときに指定したSMU/NAS Manager IP Addressが返却されます。
destIp string Hitachi Virtual File Platform※2を特定するための情報
Hitachi Virtual File Platform※2のインスタンスを作成するときに指定したdestination_addressが返却されます。
detourIp string Hitachi Virtual File Platform※2を特定するための情報
Hitachi Virtual File Platform※2のインスタンスを作成するときに指定したdetour_addressが返却されます。
syncedAlertDef string型の配列 同期されたアラート定義名
同期時点でのエージェントに適用されたすべてのアラート定義名が返却されます。
cause※1 ― エラー時の情報
― errorID string メッセージID
errorDescription string エラーメッセージ
resultType string 次の値が返却されます。
AlertDefSyncResult

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

注※2
次のファイルサーバを総称して，「Hitachi Virtual File Platform」と呼びます。
  • Hitachi Virtual File Platform
  • Hitachi Capacity Optimization
  • Hitachi Essential NAS Platform

実行例（アラート定義情報の同期）

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

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

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

リクエストヘッダー：

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

レスポンスヘッダー：

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

レスポンスボディ：

 
{
    "state": "Succeeded",
    "result": [
        {
            "syncResult": "Succeeded",
            "agent": {
                "agentType": "RAID",
                "hostName": "agent_1",
                "instanceName": "VSPG1000_instance",
                "model": "VSP G1000",
                "serialNumber": "10182"
            },
            "syncedAlertDef": [
                "AlertVSPG1000_01",
                "AlertVSPG1000_02",
                "AlertVSPG1000_03"
            ]
        },
        {
            "syncResult": "Succeeded",
            "agent": {
                "agentType": "RAID",
                "hostName": "agent_1",
                "instanceName": "VSP_instance",
                "model": "VSP",
                "serialNumber": "53039"
            },
            "syncedAlertDef": [
                "AlertVSP_01",
                "AlertVSP_02",
                "AlertVSP_03"
            ]
        },
        {
            "syncResult": "Succeeded",
            "agent": {
                "agentType": "RAID",
                "hostName": "agent_1",
                "instanceName": "USPV_instance",
                "model": "USP V",
                "serialNumber": "10007"
            },
            "syncedAlertDef": [
                "AlertUSPV_01",
                "AlertUSPV_02",
                "AlertUSPV_03"
            ]
        }
    ],
    "resultType": "AlertDefSyncResult"
}

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

[マニュアル発行元]

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