2.6.1 Updating monitoring interval
This API updates the monitoring intervals.
Important note:
- If a short monitoring interval is set, it is more likely that the subsequent collection processing will begin during the preceding collection processing. In such a case, the preceding collection processing will continue and the subsequent collection processing will be skipped.
- In addition to this, in the case of "Configuration Monitoring (Hypervisor/VM)", the subsequent processing will be skipped if one minute has not passed after the preceding processing finished. The elapsed time can be changed in the system property file (Argus.properties). For details, see the section describing the system property file (Argus.properties), in the JP1/Operations Analytics Configuration and Administration Guide.
Execution permission
Admin
API version
v1
Request format
PUT http[s]://host:port/Analytics/version/objects/MonitoringIntervalSettings/1
Request body
The structure of the request body and the object attributes are as follows:{ "hypervisorVMEnabled":"...", "hypervisorVMInterval":"...", "hypervisorVMScheduleCycleType":"...", "hypervisorVMStartHour":"...", "hypervisorVMStartMinutes":"...", "stateOfHypervisorVMEnabled":"...", "stateOfHypervisorVMInterval":"..." }
MonitoringInterval (Type: MonitoringInterval)
Attribute |
Type |
Description |
---|---|---|
hypervisorVMEnabled |
boolean |
Whether Configuration Monitoring (VM/Hypervisor) is enabled ・true: Monitoring is enabled. ・false: Monitoring is disabled. If this setting is omitted, the value already set for this item is not changed. |
hypervisorVMInterval |
int |
Interval between Configuration Monitoring periods (VM/Hypervisor) (minutes/hours/days) The specifiable values range from 1 to 9999. The execution cycle type is specified by the value for "hypervisorVMScheduleCycleType". If this setting is omitted, the value already set for this item is not changed. |
hypervisorVMScheduleCycleType |
enum |
Type of execution cycle for Configuration Monitoring (VM/Hypervisor) (For details about the specifiable values, see the table ScheduleCycleType in List of enumerators.) The specifiable values are as follows:
|
hypervisorVMStartHour |
int |
Start time of Configuration Monitoring (VM/Hypervisor) (hour) The specifiable values range from 0 to 23. If this setting is omitted, the value already set for this item is not changed. This value can be specified only when the value of the "hypervisorVMScheduleCycleType" member is "Daily". |
hypervisorVMStartMinutes |
int |
Start time of Configuration Monitoring (VM/Hypervisor) (minute) The specifiable values range from 0 to 59. If this setting is omitted, the value already set for this item is not changed. This value can be specified only when the value of the "hypervisorVMScheduleCycleType" member is "Daily". |
stateOfHypervisorVMEnabled |
boolean |
Whether State Monitoring (VM/Hypervisor) is enabled ・ true: Monitoring is enabled. ・ false: Monitoring is disabled. If this setting is omitted, the value already set for this item is not changed. |
stateOfHypervisorVMInterval |
int |
Interval between State Monitoring periods (VM/Hypervisor) (minutes) The specifiable values are 1 to 9999. If this setting is omitted, the value already set for this item is not changed. |
Response body
The structure of the response body and the object attributes are as follows:{ "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)
Attribute |
Type |
Description |
---|---|---|
instanceID |
long |
Instance ID |
configurationEnabled |
boolean |
Whether Configuration Monitoring is enabled ・true: Monitoring is enabled. ・false: Monitoring is disabled. |
configurationLastDuration |
int |
Length of the most recent Configuration Monitoring period (minutes) If collection was never performed, -1 is returned. |
configurationMaxDuration |
int |
Length of the longest Configuration Monitoring period (minutes) If collection has never been done, -1 is returned. |
configurationInterval |
int |
Interval between Configuration Monitoring periods (days) |
configurationStartHour |
int |
Start time of Configuration Monitoring (hour) |
configurationStartMinutes |
int |
Start time of Configuration Monitoring (minute) |
performanceEnabled |
boolean |
Whether Performance Monitoring is enabled ・true: Monitoring is enabled. ・false: Monitoring is disabled. |
performanceLastDuration |
int |
Length of the most recent Performance Monitoring period (minutes) If collection has never been done, -1 is returned. |
performanceMaxDuration |
int |
Length of the longest Performance Monitoring period (minutes) If collection has never been done, -1 is returned. |
performanceInterval |
int |
Interval between Performance Monitoring periods (minutes) |
hypervisorVMEnabled |
boolean |
Whether Configuration Monitoring (VM/Hypervisor) is enabled ・true: Monitoring is enabled. ・false: Monitoring is disabled. If this setting is omitted, the value already set for this item is not changed. |
hypervisorVMLastDuration |
int |
Length of the most recent Configuration Monitoring period (VM/Hypervisor) (minutes) If collection has never been done, -1 is returned. |
hypervisorVMMaxDuration |
int |
Length of the longest Configuration Monitoring period (VM/Hypervisor) (minutes) If collection has never been done, -1 is returned. |
hypervisorVMInterval |
int |
Interval between Configuration Monitoring periods (VM/Hypervisor) (minutes/hours/days) The specifiable values range from 1 to 9999. The execution cycle type is specified by the value for "hypervisorVMScheduleCycleType". If this setting is omitted, the value already set for this item is not changed. |
hypervisorVMScheduleCycleType |
enum |
Type of execution cycle for Configuration Monitoring (VM/Hypervisor) (For details about the specifiable values, see the table ScheduleCycleType in List of enumerators.) The specifiable values are as follows:
|
hypervisorVMStartHour |
int |
Start time of Configuration Monitoring (VM/Hypervisor) (hour) The specifiable values range from 0 to 23. If this setting is omitted, the value already set for this item is not changed. This value can be specified only when the value of the "hypervisorVMScheduleCycleType" member is "Daily". |
hypervisorVMStartMinutes |
int |
Start time of Configuration Monitoring (VM/Hypervisor) (minute) The specifiable values range from 0 to 59. If this setting is omitted, the value already set for this item is not changed. This value can be specified only when the value of the "hypervisorVMScheduleCycleType" member is "Daily". |
applicationEventEnabled |
boolean |
Whether Event Monitoring (Application) is enabled ・true: Monitoring is enabled. ・false: Monitoring is disabled. |
applicationEventLastDuration |
int |
Length of the most recent Event Monitoring period (Application) (minutes) If collection has never been done, -1 is returned. |
applicationEventMaxDuration |
int |
Length of the longest Event Monitoring period (Application) (minutes) If collection has never been done, -1 is returned. |
applicationEventInterval |
int |
Interval between Event Monitoring periods (Application) (minutes) |
stateOfHypervisorVMEnabled |
boolean |
Whether State Monitoring (VM/Hypervisor) is enabled ・ true: Monitoring is enabled. ・ false: Monitoring is disabled. If this setting is omitted, the value already set for this item is not changed. |
stateOfHypervisorVMLastDuration |
int |
Length of the most recent State Monitoring period (VM/Hypervisor) (minutes) If collection has never been done, -1 is returned. |
stateOfHypervisorVMMaxDuration |
int |
Length of the longest State Monitoring period (VM/Hypervisor) (minutes) If collection has never been done, -1 is returned. |
stateOfHypervisorVMInterval |
int |
Interval between State Monitoring periods (VM/Hypervisor) (minutes) The specifiable values are 1 to 9999. If this setting is omitted, the value already set for this item is not changed. |
Status codes
Status code |
Reason phrase |
Description |
---|---|---|
200 |
OK |
Success. |
400 |
Bad Request |
- A format of request body is invalid - A request is invalid. |
401 |
Unauthorized |
No login privilege. |
403 |
Forbidden |
No update privilege. |
412 |
Precondition Failed |
The server is not available. |
500 |
Internal Server Error |
Server processing error. |
Example code
[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 }