Getting a list of metrics related to resources

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

You can obtain a list of metrics for specific resources.

Execution permission

Admin, Modify

Request line

POST baseURL/v1/services/PerfComponents/actions/getFromNode/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 E2ENodeDetailParam objects necessary to execute an operation. For details, see the table below.

E2ENodeDetailParam

{
        "targetNodeID":"...",
        "targetNodeType":"..."
}

E2ENodeDetailParam (Type: E2ENodeDetailParam)

Attribute	Type	Description
targetNodeID	string	ID of the resources for which details are to be obtained
targetNodeType	enum	Type of the resources for which details are to be obtained (For details about the valid values, see the table E2ENodeType in List of enumerators.)

Attribute

Type

Description

targetNodeID

string

ID of the resources for which details are to be obtained

targetNodeType

enum

Type of the resources for which details are to be obtained

(For details about the valid values, see the table E2ENodeType in List of enumerators.)

Response body

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute	Type	Description
instanceID	string	ID of the Instance.
created	string	Date the object is generated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
updated	string	Time the object is updated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
completed	string	Time the processing completed in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
state	string	One of the following values is set: "failed": The operation failed. "success": The operation completed successfully.
affectedResource	string[]	A blank space is set.
result	anyType[]	A list of E2EPerfComponent objects. For details, see the table below.

E2EPerfComponent

{
        "instanceID":"...",
        "componentID":"...",
        "componentName":"...",
        "metricType":"...",
        "metricOrder":"...",
        "metricName":"...",
        "status":"..."
}

E2EPerfComponent (Type: E2EPerfComponent)

Attribute	Type	Description
instanceID	string	ID of the performance information for a component
componentID	string	ID of the component
componentName	string	Name of the component
metricType	enum	ID of the metric (For details about the valid values, see the table MetricType in List of enumerators.)
metricOrder	long	Order of displaying metric types
metricName	string	Name of the metric
status	enum	Status of the performance information (For details about the valid values, see the table ElementStatusType in List of enumerators.) Normal Warning Critical LinkDown Unknown NA NotMonitored NotCollected Info

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 execute privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

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

[Request Body]
{
  "name": "getFromNode",
  "href": "http://localhost:22015/Analytics/v1/services/PerfComponents/actions/getFromNode/invoke",
  "method": "POST",
  "type": "application/json",
  "parameters":[{
    "targetNodeID":"vm#ABC_172.17.17.115_vm-449",
    "targetNodeType":"CPU"
  }]
}

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 20 Jul 2016 02:52:01 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" : "b20f2b2b-99dd-4bc6-b585-c63a8ce60168",
  "created" : "2016-07-20T11:52:01.909+09:00",
  "updated" : "2016-07-20T11:52:02.095+09:00",
  "completed" : "2016-07-20T11:52:02.095+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}