Getting a list of events

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain a list of events and event-related information, such as messages, dates, and times.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/Events?page={page}&pageSize={size}

Query parameters

The following table describes the values for the supported parameters of a query string:

Parameter	Description
page={page}	(Optional) Specify the paging information (page to be obtained). Filtering conditions: Checks whether the comparison target is equal to the value
pageSize={size}	(Optional) Specify the number of items that can be displayed on 1 page. Filtering conditions: Checks whether the comparison target is equal to the value

Parameter

Description

page={page}

(Optional) Specify the paging information (page to be obtained).

Filtering conditions:

Checks whether the comparison target is equal to the value

pageSize={size}

(Optional) Specify the number of items that can be displayed on 1 page.

Filtering conditions:

Checks whether the comparison target is equal to the value

Request body

Not applicable.

Response body

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	A list of Event objects. For details, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	Page.
pageSize	integer	Size of page.
numPages	integer	Number of pages.
totalCount	integer	Number of objects.

Event

{
        "instanceID":"...",
        "level":"...",
        "message":"...",
        "dateTime":"...",
        "category":"...",
        "nodeId":"...",
        "deviceName":"...",
        "deviceType":"...",
        "componentId":"...",
        "componentName":"...",
        "componentType":"...",
        "targetMetric":"...",
        "targetMetricName":"...",
        "profileName":"...",
        "planName":"...",
        "thresholdValue":"...",
        "thresholdUnit":"..."
}

Event (Type: Event)

Attribute	Type	Description
instanceID	string	ID of the event
level	enum	Event level (For details about the valid values, see the table EventSeverityType in List of enumerators.) INFO WARNING CRITICAL
message	string	Event message
dateTime	dateTime	Event issuance time
category	enum	Event category (For details about the valid values, see the table EventCategoryType in List of enumerators.) PERFORMANCE EVENT SETTING
nodeId	string	ID of the device for which the event was issued
deviceName	string	Name of the device for which the event was issued
deviceType	enum	Type of the device for which the event was issued (For details about the valid values, see the table NodeDisplayType in List of enumerators.) Unknown Server Storage NetworkDevice Datastore
componentId	string	ID of the component for which the event was issued
componentName	string	Name of the component for which the event was issued
componentType	enum	Type of the component for which the event was issued (For details about the valid values, see the table ComponentType in List of enumerators.)
targetMetric	enum	ID of the metric for which the event was issued. This item is displayed only if the category is "Performance". (For details about the valid values, see the table MetricType in List of enumerators.)
targetMetricName	string	Name of the metric for which the event was issued. This item is displayed only if the category is "Performance".
profileName	string	Name of the threshold profile for which the event was issued. This item is displayed only if the category is "Performance".
planName	string	Name of the plan set for the threshold profile for which the event was issued. This item is displayed only if the category is "Performance".
thresholdValue	string	Threshold for which the event was issued. This item is displayed only if the category is "Performance".
thresholdUnit	string	Unit of the threshold for which the event was issued. This item is displayed only if the category is "Performance".

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/Events
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 20 Jul 2016 02:26:03 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]
{
  "data" : [ {
    "instanceID" : "Setting##1468980297687##0##INFO##null####null##",
    "status" : "NOTACK",
    "level" : "INFO",
    "message" : "The service started. (host:localhost)",
    "dateTime" : "2016-07-20T11:04:57.687+09:00",
    "category" : "SETTING",
    "thresholdValue" : 0.0
  }, {
    "instanceID" : "Setting##1468971056202##0##INFO##null####null##",
    "status" : "NOTACK",
    "level" : "INFO",
    "message" : "The service started. (host:localhost)",
    "dateTime" : "2016-07-20T08:30:56.202+09:00",
    "category" : "SETTING",
    "thresholdValue" : 0.0
  } ],
  "count" : 2
}