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

3.4 アラート定義情報の参照

追加したアラート定義情報を参照します。

HTTPリクエスト構文（URI）
参照したいアラート定義が1件の場合
参照したいアラート定義のアラート定義名を指定します。
GET  <scheme>://<host>:<port>/<application>/<version>/objects/alert-defs/<AlertDefId>
参照したいアラート定義が複数件の場合
参照したいアラート定義をクエリ文字列で指定します。アラート定義名だけがレスポンスとして返却されます。
GET  <scheme>://<host>:<port>/<application>/<version>/objects/alert-defs?<query-string>
参照したいアラート定義が全件の場合
アラート定義名だけがレスポンスとして返却されます。
GET  <scheme>://<host>:<port>/<application>/<version>/objects/alert-defs
クエリ文字列

参照したいアラート定義が複数件の場合，条件に合わせてAlertDefNameまたはTargetのどちらかのキーを指定してください。

アラート定義名で指定する場合

クエリ文字列の指定例：

AlertDefName=Alert1%1FAlert2

「Alert1」と「Alert2」の2つのアラート定義を指定しています。

表3-4 アラート定義取得時に指定可能なクエリ文字列のキーと値（アラート定義名の場合）

キー値

値域概要

AlertDefName 1～127バイトアラート定義名を指定します。
複数指定したい場合は，キーと値の組み合わせを複数指定するか，値を%1Fで区切って指定してください。

監視対象で指定する場合

クエリ文字列の指定例：

Target=VSP%20G1000%1F12345

対象のストレージシステムが「VSP G1000」，かつ，シリアル番号が「12345」のアラート定義を指定しています。

表3-5 アラート定義取得時に指定可能なクエリ文字列のキーと値（監視対象の場合）

キー値

値域概要

Target 1～1,024バイト取得したいアラート定義を絞り込むための文字列を指定します。絞り込み条件としては，target型のtargetDef型の変数keyに定義する情報型の値を指定します。
複数の条件で絞り込む場合は，キーと値の組み合わせを複数指定するか，値を%1Fで区切って指定します。

リクエストの構造

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

レスポンスの構造

参照したいアラート定義が1件の場合
{
    "alertDefName": "<アラート定義名>",
    <アラート定義型オブジェクト>
}
アラート定義型オブジェクトについては，「3.11 アラート定義情報設定時のオブジェクト」および「A.2 アラート定義情報の作成手順」を参照してください。

参照したいアラート定義が複数件または全件の場合
{
    "data": [
        {
            "alertDefName": "<アラート定義名>"
        },
        {
            "alertDefName": "<アラート定義名>"
        },
        {
            "alertDefName": "<アラート定義名>"
        },
                   :
    ]
}
実行例1（参照したいアラート定義が1件）

curlコマンドを使用したリクエストメッセージ：
curl -v -H "Content-Type: application/json" -u system:manager -X GET http://server_1:22015/DeviceManagerWebService/analytics/v1/objects/alert-defs/AlertVSPG1000_01
リクエストに対する実行結果／

リクエストヘッダー：
GET /DeviceManagerWebService/analytics/v1/objects/alert-defs/AlertVSPG1000_01 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
レスポンスヘッダー：
HTTP/1.1 200 OK
Date: Tue, 20 Oct 2015 07:18:29 GMT
Server: Cosminexus HTTP Server
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
レスポンスボディ：
 
{
    "alertDefName": "AlertVSPG1000_01",
    "targets": [
        {
            "targetID": "target1",
            "targetDef": [
                {
                    "type": "model",
                    "key": {
                        "model": "VSP G1000"
                    },
                    "filters": null
                }
            ]
        }
    ],
    "notices": [
        {
            "noticeID": "notice1",
            "emailNotification": [
                "warning",
                "caution",
                "normal"
            ],
            "emails": [
                {
                    "addresses": [
                        "alert@example.com"
                    ],
                    "subject": "HTnM Alert Mail",
                    "body": "Alert Mail"
                }
            ]
        }
    ],
    "triggers": [
        {
            "triggerID": "trigger1",
            "isActive": "Y",
            "monitorAlways": "Y",
            "monitoringTime": null,
            "alertEveryTime": "Y",
            "evaluateAllData": "Y",
            "evaluatePoR": "N",
            "condition": {
                "targetOfPoR": null,
                "warning": "%PI_LDS.READ_IO_COUNT% > '3000'",
                "caution": "%PI_LDS.READ_IO_COUNT% > '2000'"
            },
            "frequency": null
        }
    ],
    "definitions": [
        {
            "targetIDs": [
                "target1"
            ],
            "noticeIDs": [
                "notice1"
            ],
            "triggerIDs": [
                "trigger1"
            ]
        }
    ],
    "formatVersion": "1.0"
}
実行例2（クエリ指定（アラート定義名指定））

curlコマンドを使用したリクエストメッセージ：
curl -v -H "Content-Type: application/json" -u system:manager -X GET http://server_1:22015/DeviceManagerWebService/analytics/v1/objects/alert-defs?AlertDefName=AlertVSPG1000_01
リクエストに対する実行結果／

リクエストヘッダー：
GET /DeviceManagerWebService/analytics/v1/objects/alert-defs?AlertDefName=AlertVSPG1000_01 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
レスポンスヘッダー：
HTTP/1.1 200 OK
Date: Tue, 20 Oct 2015 07:18:30 GMT
Server: Cosminexus HTTP Server
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
レスポンスボディ：
 
{
    "data": [
        {
            "alertDefName": "AlertVSPG1000_01"
        }
    ]
}
実行例3（クエリ指定（Target指定））

curlコマンドを使用したリクエストメッセージ：
curl -v -H "Content-Type: application/json" -u system:manager -X GET http://server_1:22015/DeviceManagerWebService/analytics/v1/objects/alert-defs?Target=VSP%20G1000
リクエストに対する実行結果／

リクエストヘッダー：
GET /DeviceManagerWebService/analytics/v1/objects/alert-defs?Target=VSP%20G1000 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
レスポンスヘッダー：
HTTP/1.1 200 OK
Date: Tue, 20 Oct 2015 07:18:30 GMT
Server: Cosminexus HTTP Server
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
レスポンスボディ：
 
{
    "data": [
        {
            "alertDefName": "AlertVSPG1000_01"
        },
        {
            "alertDefName": "AlertVSPG1000_02"
        },
        {
            "alertDefName": "AlertVSPG1000_03"
        }
    ]
}
実行例4（参照したいアラート定義が全件）

curlコマンドを使用したリクエストメッセージ：
curl -v -H "Content-Type: application/json" -u system:manager -X GET http://server_1:22015/DeviceManagerWebService/analytics/v1/objects/alert-defs
リクエストに対する実行結果／

リクエストヘッダー：
GET /DeviceManagerWebService/analytics/v1/objects/alert-defs 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
レスポンスヘッダー：
HTTP/1.1 200 OK
Date: Tue, 20 Oct 2015 07:18:29 GMT
Server: Cosminexus HTTP Server
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
レスポンスボディ：
 
{
    "data": [
        {
            "alertDefName": "AlertVSPG1000_01"
        },
        {
            "alertDefName": "AlertVSPG1000_02"
        },
        {
            "alertDefName": "AlertVSPG1000_03"
        },
        {
            "alertDefName": "AlertUSPV_01"
        },
        {
            "alertDefName": "AlertUSPV_02"
        },
        {
            "alertDefName": "AlertUSPV_03"
        },
        {
            "alertDefName": "AlertVSP_01"
        },
        {
            "alertDefName": "AlertVSP_02"
        },
        {
            "alertDefName": "AlertVSP_03"
        }
    ]
}

キー	値
値域	概要
AlertDefName	1～127バイト	アラート定義名を指定します。複数指定したい場合は，キーと値の組み合わせを複数指定するか，値を`%1F`で区切って指定してください。

キー	値
値域	概要
Target	1～1,024バイト	取得したいアラート定義を絞り込むための文字列を指定します。絞り込み条件としては，`target`型の`targetDef`型の変数`key`に定義する情報型の値を指定します。複数の条件で絞り込む場合は，キーと値の組み合わせを複数指定するか，値を`%1F`で区切って指定します。

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

[マニュアル発行元]