Getting the number of user resources counted for each metric and for each status

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

You can obtain the number of user resources counted for each metric and for each status.

Execution permission

Admin, Modify

Request line

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

GetComponentStatusCountByMetricParam

{
        "componentType":"...",
        "metricTypes":["...", ...],
        "metricMonitorStatuses":["...", ...],
        "componentMonitorStatuses":["...", ...],
        "parentNodeMonitorStatuses":["...", ...],
        "metricStatuses":["...", ...]
}

GetComponentStatusCountByMetricParam (Type: GetComponentStatusCountByMetricParam)

Attribute	Type	Description
componentType	enum	Type of user resources to be aggregated (For details about the valid values, see the table ComponentType in List of enumerators.) STORAGE_VOLUME VIRTUAL_MACHINE
metricTypes	enum[]	ID of the metric to be aggregated (For details about the valid values, see the table MetricType in List of enumerators.)
metricMonitorStatuses	enum[]	Monitoring status of metric to be aggregated. (For details about the valid values, see the table MetricMonitorStatus in List of enumerators.) Monitor MonitorOff
componentMonitorStatuses	enum[]	Monitoring status of user resources to be aggregated. Always specify "InUse". (For details about the valid values, see the table ComponentMonitorType in List of enumerators.) InUse NotMonitored
parentNodeMonitorStatuses	enum[]	Monitoring status of the device that the aggregation-target user resources belong to. Always specify "Manage". (For details about the valid values, see the table ManagementLevelType in List of enumerators.) Manage
metricStatuses	enum[]	Status of metrics to be aggregated (For details about the valid values, see the table ElementStatusType in List of enumerators.) Normal Warning Critical Unknown NotMonitored

Response body

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

ComponentStatusCountByMetric

{
        "componentStatus":"...",
        "count":"...",
        "componentIds":["...", ...]
}

ComponentStatusCountByMetric (Type: ComponentStatusCountByMetric)

Attribute	Type	Description
componentStatus	enum	Status of the user resource (For details about the valid values, see the table ElementStatusType in List of enumerators.) Normal Warning Critical Unknown NotMonitored
count	int	Number of user resources
componentIds	string[]	ID of the user resource

Attribute

Type

Description

componentStatus

enum

Status of the user resource

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

Normal
Warning
Critical
Unknown
NotMonitored

count

int

Number of user resources

componentIds

string[]

ID of the user resource

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 update 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]
POST /Analytics/v1/services/UserResource/actions/getComponentStatusCountByMetric/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
  "name": "getComponentStatusCountByMetric",
  "href": "http://localhost:22015/Analytics/v1/services/UserResource/actions/getComponentStatusCountByMetric/invoke",
  "method": "POST",
  "type": "application/json",
  "parameters":[{
    "componentType":"VIRTUAL_MACHINE",
    "metricTypes":["ESX_VM_VM_NETDROPPEDRX","ESX_VM_VM_NETDROPPEDTX"],
    "metricMonitorStatuses":["Monitor"],
    "componentMonitorStatuses":["InUse"],
    "parentNodeMonitorStatuses":["Manage"],
    "metricStatuses":["Warning","Critical"]
  }]
}

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:54:25 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]
{
  "instanceID" : "52bdddf9-6b3b-437f-b954-43536a11ede6",
  "created" : "2016-08-12T02:54:29.467+09:00",
  "updated" : "2016-08-12T02:54:29.467+09:00",
  "completed" : "2016-08-12T02:54:29.467+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}