2.6.1 収集間隔の更新
収集間隔の更新を行います。
■使用上の注意事項
・収集間隔を短く設定した場合,収集処理中に,後続の収集処理が開始される可能性が高くなります。そのような場合は,先行している収集処理は継続され,後続の収集処理がスキップされます。
・「構成の収集(仮想マシン/ハイパーバイザー)」の場合,上記に加え,”前回の収集完了日時”から1分経過していない場合も,後続の収集処理がスキップされます。経過時間はシステムプロパティファイル(Argus.properties)で変更することが可能です。設定方法はマニュアルJP1/Operations Analytics 構築・運用ガイドのシステムプロパティファイル(Argus.properties)について説明している個所を参照してください。
権限
Admin
APIのバージョン
v1
リクエスト形式
PUT http[s]://host:port/Analytics/version/objects/MonitoringIntervalSettings/1
リクエストボディー
リクエストボディーの構造とオブジェクトの属性を次に示します。{ "hypervisorVMEnabled":"...", "hypervisorVMInterval":"...", "hypervisorVMScheduleCycleType":"...", "hypervisorVMStartHour":"...", "hypervisorVMStartMinutes":"...", "stateOfHypervisorVMEnabled":"...", "stateOfHypervisorVMInterval":"..." }
MonitoringInterval (Type: MonitoringInterval)
属性 |
データ型 |
説明 |
---|---|---|
hypervisorVMEnabled |
boolean |
構成の収集(仮想マシン/ハイパーバイザー)を有効にするかどうか。 ・true:有効にする ・false:無効にする 省略時は既に設定されている値を変更しません。 |
hypervisorVMInterval |
int |
構成の収集(仮想マシン/ハイパーバイザー)の収集間隔(分/時/日) 指定できる値は1~9999です。実行周期タイプは"hypervisorVMScheduleCycleType"メンバーで指定します。省略時は既に設定されている値を変更しません。 |
hypervisorVMScheduleCycleType |
enum |
構成の収集(仮想マシン/ハイパーバイザー)の収集実行周期タイプ。 (指定可能な値は「列挙型一覧」のScheduleCycleTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
hypervisorVMStartHour |
int |
構成の収集(仮想マシン/ハイパーバイザー)の開始時刻(時) 指定できる値は0~23です。省略時は既に設定されている値を変更しません。"hypervisorVMScheduleCycleType"メンバーの値が"Daily"の場合にのみ指定できます。 |
hypervisorVMStartMinutes |
int |
構成の収集(仮想マシン/ハイパーバイザー)の開始時刻(分) 指定できる値は0~59です。省略時は既に設定されている値を変更しません。"hypervisorVMScheduleCycleType"メンバーの値が"Daily"の場合にのみ指定できます。 |
stateOfHypervisorVMEnabled |
boolean |
状態の収集(仮想マシン/ハイパーバイザー)を有効にするかどうか。 ・true:有効にする ・false:無効にする 省略時は既に設定されている値を変更しません。 |
stateOfHypervisorVMInterval |
int |
状態の収集(仮想マシン/ハイパーバイザー)の収集間隔(分) 指定できる値は1~9999です。省略時は既に設定されている値を変更しません。 |
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "instanceID":"...", "configurationEnabled":"...", "configurationLastDuration":"...", "configurationMaxDuration":"...", "configurationInterval":"...", "configurationStartHour":"...", "configurationStartMinutes":"...", "performanceEnabled":"...", "performanceLastDuration":"...", "performanceMaxDuration":"...", "performanceInterval":"...", "hypervisorVMEnabled":"...", "hypervisorVMLastDuration":"...", "hypervisorVMMaxDuration":"...", "hypervisorVMInterval":"...", "hypervisorVMScheduleCycleType":"...", "hypervisorVMStartHour":"...", "hypervisorVMStartMinutes":"...", "applicationEventEnabled":"...", "applicationEventLastDuration":"...", "applicationEventMaxDuration":"...", "applicationEventInterval":"...", "stateOfHypervisorVMEnabled":"...", "stateOfHypervisorVMLastDuration":"...", "stateOfHypervisorVMMaxDuration":"...", "stateOfHypervisorVMInterval":"..." }
MonitoringInterval (Type: MonitoringInterval)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
インスタンスを特定するID |
configurationEnabled |
boolean |
構成の収集が有効であるかどうか。 ・true:有効である ・false:無効である |
configurationLastDuration |
int |
構成の収集の最新の所要時間(分) 収集が一度も行われていない場合は-1が返却されます。 |
configurationMaxDuration |
int |
構成の収集の最長の所要時間(分) 収集が一度も行われていない場合は-1が返却されます。 |
configurationInterval |
int |
構成の収集の収集間隔(日) |
configurationStartHour |
int |
構成の収集の開始時刻(時) |
configurationStartMinutes |
int |
構成の収集の開始時刻(分) |
performanceEnabled |
boolean |
性能の収集が有効であるかどうか。 ・true:有効である ・false:無効である |
performanceLastDuration |
int |
性能の収集の最新の所要時間(分) 収集が一度も行われていない場合は-1が返却されます。 |
performanceMaxDuration |
int |
性能の収集の最長の所要時間(分) 収集が一度も行われていない場合は-1が返却されます。 |
performanceInterval |
int |
性能の収集の収集間隔(分) |
hypervisorVMEnabled |
boolean |
構成の収集(仮想マシン/ハイパーバイザー)を有効にするかどうか。 ・true:有効にする ・false:無効にする 省略時は既に設定されている値を変更しません。 |
hypervisorVMLastDuration |
int |
構成の収集(仮想マシン/ハイパーバイザー)の最新の所要時間(分) 収集が一度も行われていない場合は-1が返却されます。 |
hypervisorVMMaxDuration |
int |
構成の収集(仮想マシン/ハイパーバイザー)の最長の所要時間(分) 収集が一度も行われていない場合は-1が返却されます。 |
hypervisorVMInterval |
int |
構成の収集(仮想マシン/ハイパーバイザー)の収集間隔(分/時/日) 指定できる値は1~9999です。実行周期タイプは"hypervisorVMScheduleCycleType"メンバーで指定します。省略時は既に設定されている値を変更しません。 |
hypervisorVMScheduleCycleType |
enum |
構成の収集(仮想マシン/ハイパーバイザー)の収集実行周期タイプ。 (指定可能な値は「列挙型一覧」のScheduleCycleTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
hypervisorVMStartHour |
int |
構成の収集(仮想マシン/ハイパーバイザー)の開始時刻(時) 指定できる値は0~23です。省略時は既に設定されている値を変更しません。"hypervisorVMScheduleCycleType"メンバーの値が"Daily"の場合にのみ指定できます。 |
hypervisorVMStartMinutes |
int |
構成の収集(仮想マシン/ハイパーバイザー)の開始時刻(分) 指定できる値は0~59です。省略時は既に設定されている値を変更しません。"hypervisorVMScheduleCycleType"メンバーの値が"Daily"の場合にのみ指定できます。 |
applicationEventEnabled |
boolean |
イベントの収集(アプリケーション)が有効であるかどうか。 ・true:有効である ・false:無効である |
applicationEventLastDuration |
int |
イベントの収集(アプリケーション)の最新の所要時間(分) 収集が一度も行われていない場合は-1が返却されます。 |
applicationEventMaxDuration |
int |
イベントの収集(アプリケーション)の最長の所要時間(分) 収集が一度も行われていない場合は-1が返却されます。 |
applicationEventInterval |
int |
イベントの収集(アプリケーション)の収集間隔(分) |
stateOfHypervisorVMEnabled |
boolean |
状態の収集(仮想マシン/ハイパーバイザー)を有効にするかどうか。 ・true:有効にする ・false:無効にする 省略時は既に設定されている値を変更しません。 |
stateOfHypervisorVMLastDuration |
int |
状態の収集(仮想マシン/ハイパーバイザー)の最新の所要時間(分) 収集が一度も行われていない場合は-1が返却されます。 |
stateOfHypervisorVMMaxDuration |
int |
状態の収集(仮想マシン/ハイパーバイザー)の最長の所要時間(分) 収集が一度も行われていない場合は-1が返却されます。 |
stateOfHypervisorVMInterval |
int |
状態の収集(仮想マシン/ハイパーバイザー)の収集間隔(分) 指定できる値は1~9999です。省略時は既に設定されている値を変更しません。 |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
400 |
Bad Request |
・リクエストボディ形式不正 ・リクエスト不正 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
更新権限がない |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] PUT /Analytics/v1/objects/MonitoringIntervalSettings/1 HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: curl/7.33.0 Host: localhost:22015 Accept: application/json Content-Type: application/json Accept-Language: ja Content-Length: 263 [Request Body] { "hypervisorVMEnabled": true, "hypervisorVMInterval": 5, "hypervisorVMScheduleCycleType": "Minutely", "hypervisorVMStartHour": 0, "hypervisorVMStartMinutes": 0, "stateOfHypervisorVMEnabled": true, "stateOfHypervisorVMInterval": 1 } [Response Header] HTTP/1.1 200 OK Date: Fri, 27 Nov 2015 08:42:45 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 4afe674fe8a4e569aa824d8786b0ac5b53e4a_WVlGcHsLfg5ffg0I_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "instanceID": 1, "configurationEnabled": true, "configurationLastDuration": -1, "configurationMaxDuration": -1, "configurationInterval": 1, "configurationStartHour": 0, "configurationStartMinutes": 45, "performanceEnabled": true, "performanceLastDuration": -1, "performanceMaxDuration": -1, "performanceInterval": 5, "hypervisorVMEnabled": true, "hypervisorVMLastDuration": -1, "hypervisorVMMaxDuration": -1, "hypervisorVMInterval": 5, "hypervisorVMScheduleCycleType": "Minutely", "hypervisorVMStartHour": 0, "hypervisorVMStartMinutes": 0, "applicationEventEnabled": true, "applicationEventLastDuration": -1, "applicationEventMaxDuration": -1, "applicationEventInterval": 5, "stateOfHypervisorVMEnabled": true, "stateOfHypervisorVMLastDuration": -1, "stateOfHypervisorVMMaxDuration": -1, "stateOfHypervisorVMInterval": 1 }