Preparing to obtain metric information

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 information related to metrics, such as the display name and unit.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/services/PerformanceData/actions/getMetricData

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 MetricDataParam objects necessary to execute an operation. For details, see the table below.

MetricDataParam

{
        "resourceType":"...",
        "componentType":"...",
        "priority":"...",
        "metricType":"..."
}

MetricDataParam (Type: MetricDataParam)

Attribute	Type	Description
resourceType	enum	Type of resource that the metric belongs to (For details about the valid values, see the table PerformanceResourceType in List of enumerators.)
componentType	enum	Type of component that the metric belongs to (For details about the valid values, see the table ComponentType in List of enumerators.)
priority	enum	Priority of the metric (For details about the valid values, see the table MetricPriorityType in List of enumerators.)
metricType	enum	Type of the metric (For details about the valid values, see the table MetricType in List of enumerators.)

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
403	Forbidden	No reference 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]
GET /Analytics/v1/services/PerformanceData/actions/getMetricData
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:56:01 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8113b75377dac59b7c48ee2b947b20d3bbc11f_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]
{
  "name" : "getMetricData",
  "href" : "http://localhost:22015/Analytics/v1/services/PerformanceData/actions/getMetricData/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "resourceType" : "ESX_VM",
    "componentType" : "VIRTUAL_MACHINE",
    "priority" : "Basic",
    "metricType" : "ESX_VM_VM_CPUREADY"
  } ]
}