Getting a list of configuration change histories

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain a list of histories of configuration changes.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/ChangeHistorys?$query={HQL}&page={page}&pageSize={size}

Query parameters

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

Parameter	Description
$query={HQL}	(Required) Using HQL. Specify the following parameters. nodeID ((Optional) Multiple values can be specified.) componentID ((Optional) Multiple values can be specified.) instanceIDofEvent ((Optional) Multiple values can be specified.) NodeDisplayType ((Optional) Only one value can be specified.) ComponentType ((Optional) Only one value can be specified.) ObtainingTimeRange ((Optional) Only one value can be specified.) Filtering conditions: Specify using HQL standard.
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

$query={HQL}

(Required) Using HQL. Specify the following parameters.

nodeID ((Optional) Multiple values can be specified.)

componentID ((Optional) Multiple values can be specified.)

instanceIDofEvent ((Optional) Multiple values can be specified.)

NodeDisplayType ((Optional) Only one value can be specified.)

ComponentType ((Optional) Only one value can be specified.)

ObtainingTimeRange ((Optional) Only one value can be specified.)

Filtering conditions:

Specify using HQL standard.

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 ChangeHistory 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.

ChangeHistory

{
        "instanceID":"...",
        "message":"...",
        "dateTime":"...",
        "nodeId":"...",
        "deviceName":"...",
        "deviceType":"...",
        "componentId":"...",
        "componentName":"...",
        "componentType":"...",
        "attributeType":"...",
        "previousValue":"...",
        "newValue":"...",
        "componentChangeType":"...",
        "nodeChangeType":"..."
}

ChangeHistory (Type: ChangeHistory)

Attribute	Type	Description
instanceID	string	ID of the configuration change history
message	string	Message of the configuration change history
dateTime	dateTime	Configuration change detection time
nodeId	string	ID of the device for which the configuration change occurred
deviceName	string	Name of the device for which the configuration change occurred
deviceType	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
componentId	string	ID of the component for which the configuration change occurred
componentName	string	Name of the component for which the configuration change occurred
componentType	enum	Type of component for which the configuration change occurred (For details about the valid values, see the table ComponentType in List of enumerators.)
attributeType	enum	Attribute type of component for which the configuration change occurred (For details about the valid values, see the table ComponentAttributeType in List of enumerators.)
previousValue	string	Value before the configuration is changed
newValue	string	Value after the configuration is changed
componentChangeType	enum	Modification type of component for which the configuration change occurred (For details about the valid values, see the table ChangeEventType in List of enumerators.) ADD MODIFY REMOVE
nodeChangeType	enum	Modification type of device for which the configuration change occurred (For details about the valid values, see the table ChangeEventType in List of enumerators.) ADD MODIFY REMOVE

Status codes

Status code	Reason phrase	Description
200	OK	Success.
400	Bad Request	- The format of the request body is invalid. - A query parameter is invalid.
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/ChangeHistorys/?HQL::filter=componentId+eq+'vm%23ITPDLab_172.17.17.115_vm-149' HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 22 Aug 2016 07:03:23 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 359359188f9afdee4c32c10c6c8bf8567ada4_YXZvNFILd2IcDAIaWXcFMFR3FVc=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Content-Type: application/json

[Response Body]

    {
        "data":
        [
            {
                "instanceID": "16$1201$vm#ITPDLab_172.17.17.115_vm-149$vm#ITPDLab_172.17.17.115_vm-149$null$1471252355000$MODIFY",
                "message": "The number of CPU cores was changed from 2 to 1.
    Device name: 172.17.17.119
    Name of VM: CT003hoshi",
                "dateTime": "2016-08-15T18:12:35.000+09:00",
                "nodeId": "h#ITPDLab_172.17.17.115_host-143",
                "deviceName": "172.17.17.119",
                "deviceType": "Server",
                "componentId": "vm#ITPDLab_172.17.17.115_vm-149",
                "componentName": "CT003hoshi",
                "componentType": "VIRTUAL_MACHINE",
                "attributeType": "NUM_OF_CPU_CORES",
                "previousValue": "2",
                "newValue": "1",
                "componentChangeType": "MODIFY",
                "nodeChangeType": "MODIFY"
            },
            {
                "instanceID": "16$1202$vm#ITPDLab_172.17.17.115_vm-149$vm#ITPDLab_172.17.17.115_vm-149$null$1471252355000$MODIFY",
                "message": "Memory size was changed from 2.0 GB to 4.0 GB.
    Device name: 172.17.17.119
    Name of VM: CT003hoshi",
                "dateTime": "2016-08-15T18:12:35.000+09:00",
                "nodeId": "h#ITPDLab_172.17.17.115_host-143",
                "deviceName": "172.17.17.119",
                "deviceType": "Server",
                "componentId": "vm#ITPDLab_172.17.17.115_vm-149",
                "componentName": "CT003hoshi",
                "componentType": "VIRTUAL_MACHINE",
                "attributeType": "TOTAL_MEMORY",
                "previousValue": "2.0 GB",
                "newValue": "4.0 GB",
                "componentChangeType": "MODIFY",
                "nodeChangeType": "MODIFY"
            }
        ],
        "count": 2
    }