Preparing to obtain the number of configuration changes

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

The following operation is the initial step to obtain the number of configuration changes.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/services/ChangeHistorys/actions/getCount

Request body

Not applicable.

Response body

The structure of the response body and the object attributes is 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 GetChangeCountParam objects necessary to execute an operation. For details, see the table below.

GetChangeCountParam

{
        "nodeIDs":["...", ...],
        "deviceTypes":["...", ...],
        "countFrom":"...",
        "countTo":"...",
        "interval":"..."
}

GetChangeCountParam (Type: GetChangeCountParam)

Attribute	Type	Description
nodeIDs	long[]	ID of the device for which the configuration change occurred
deviceTypes	enum[]	Type of device for which the configuration change occurred (For details about the valid values, see the table NodeDisplayType in List of enumerators.) Server Storage NetworkDevice Datastore
countFrom	dateTime	Aggregation start time of the configuration change history
countTo	dateTime	Aggregation end time of the configuration change history
interval	long	Aggregation interval of the configuration change history (ms).

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/services/ChangeHistorys/actions/getCount HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Tue, 23 Aug 2016 12:21:20 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO be34d9f31129bb09cf2b1a132b6d5c28e81be1_YXZvNFILd2IcDAIaWXcFMFR3FVc=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Content-Type: application/json

[Response Body]
{
  "name" : "getCount",
  "href" : "http://localhost:22015/Analytics/v1/services/ChangeHistorys/actions/getCount/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "nodeIDs" : [ ],
    "deviceTypes" : [ "Server", "NetworkDevice", "Storage" ],
    "countFrom" : "2016-08-22T21:21:20.236+09:00",
    "countTo" : "2016-08-23T21:21:20.236+09:00",
    "interval" : 3600000
  } ]
}