Getting a number of events

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain the number of events that occurred within a specific time period.

Execution permission

Admin, Modify

Request line

POST baseURL/v1/services/Events/actions/getEventCount/invoke

Request body

The structure of the request body and the object attributes are as follows:

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

Attribute	Type	Description
name	string	Name of the action.
href	string	URL for the action.
method	string	Name of the method.
type	string	Data format for the object.
parameters	anyType[]	A list of GetEventCountParam objects necessary to execute an operation. For details, see the table below.

GetEventCountParam

{
        "categories":["...", ...],
        "countFrom":"...",
        "countTo":"...",
        "interval":"..."
}

GetEventCountParam (Type: GetEventCountParam)

Attribute	Type	Description
categories	enum[]	Category of events to be aggregated (For details about the valid values, see the table EventCategoryType in List of enumerators.) PERFORMANCE EVENT SETTING
countFrom	dateTime	Start time of the period for which the events is to be obtained
countTo	dateTime	End time of the period for which the events is to be obtained
interval	long	Aggregation interval (ms).

Response body

The structure of the response body and the object attributes is as follows:

EventCount

{
        "periodFrom":"...",
        "info":"...",
        "warning":"...",
        "critical":"...",
        "total":"..."
}

EventCount (Type: EventCount)

Attribute	Type	Description
periodFrom	dateTime	Event aggregation time
info	long	Number of information events that occurred during the aggregation interval
warning	long	Number of warning events that occurred during the aggregation interval
critical	long	Number of critical events that occurred during the aggregation interval
total	long	Total number of events that occurred during the aggregation interval

Status codes

Status code	Reason phrase	Description
200	OK	Success.
400	Bad Request	The format of the request body is invalid.
401	Unauthorized	No login privilege.
403	Forbidden	No update privilege.
404	Not Found	The resource was not found.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/Events/actions/getEventCount/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
  "name": "getEventCount",
  "href":  "http://localhost:22015/Analytics/v1/services/Events/actions/getEventCount/invoke",
  "method": "POST",
  "type": "application/json",
  "parameters":[{
    "countFrom":"2016-07-19T11:26:04.476+09:00",
    "countTo":"2016-07-20T11:26:04.476+09:00",
    "interval":"3600000"
  }]
}

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 20 Jul 2016 02:26:04 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 33659a74fcee4358dc272b34eca6ded1bf1131ec_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "instanceID" : "79e6e2e0-a800-4b22-bb5d-25424ca65a51",
  "created" : "2016-07-20T11:26:04.966+09:00",
  "updated" : "2016-07-20T11:26:05.047+09:00",
  "completed" : "2016-07-20T11:26:05.047+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "periodFrom" : "2016-07-19T11:26:04.476+09:00",
    "info" : 0,
    "warning" : 0,
    "critical" : 0,
    "total" : 0
  }, {
   ........
  }, {
    "periodFrom" : "2016-07-20T10:26:04.476+09:00",
    "info" : 2,
    "warning" : 0,
    "critical" : 0,
    "total" : 2
  } ]
}