Getting system summary information

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain system summary information (summaries of the status of consumers and user resources).

Execution permission

Admin, Modify

Request line

POST baseURL/v1/services/SystemSummary/actions/getSystemStatusSummary/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 objects necessary to execute an operation. No value is set.

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 GetSystemStatusSummary objects. For details, see the table below.

GetSystemStatusSummary

{
        "status":"...",
        "statusMessage":"...",
        "messageHighlightParams":["...", ...],
        "groupSummaries":[{
            "key":"...",
            "name":"...",
            "critical":"...",
            "warning":"...",
            "total":"..."
        },
        :
        ],
        "vmSummary":{
            "key":"...",
            "name":"...",
            "critical":"...",
            "warning":"...",
            "total":"..."
        },
        "hostSummary":{
            "key":"...",
            "name":"...",
            "critical":"...",
            "warning":"...",
            "total":"..."
        },
        "volumeSummary":{
            "key":"...",
            "name":"...",
            "critical":"...",
            "warning":"...",
            "total":"..."
        }
}

GetSystemStatusSummary (Type: GetSystemStatusSummary)

Attribute	Type	Description
status	enum	Most severe one of the statuses in the entire system (For details about the valid values, see the table SystemSummaryStatus in List of enumerators.) CRITICAL WARNING NORMAL INFORMATION
statusMessage	string	Message indicating the status of the entire system. The specified message might include variables. Each variable is specified in {n} format, where "n" is an argument sequence number that is 0 or a larger integer. (Example: Status is {0}.)
messageHighlightParams	string[]	Variables used in a message that indicates the status of the entire system. The specified variables are set in the message in the order they are specified. (Example: Critical)
groupSummaries	CategorySummary[]	Status aggregated by consumer
vmSummary	CategorySummary	Status aggregated by virtual machine
hostSummary	CategorySummary	Status aggregated by host
volumeSummary	CategorySummary	Status aggregated by volume

groupSummaries (Type: CategorySummary)

Attribute	Type	Description
key	string	Key used for aggregation. This item is set only if the category is Consumer.
name	string	Name of the category used for aggregation. This item is set only if the category is Consumer.
critical	long	Number of criticals
warning	long	Number of warnings
total	long	Total

vmSummary (Type: CategorySummary)

Attribute	Type	Description
key	string	Key used for aggregation. This item is set only if the category is Consumer.
name	string	Name of the category used for aggregation. This item is set only if the category is Consumer.
critical	long	Number of criticals
warning	long	Number of warnings
total	long	Total

hostSummary (Type: CategorySummary)

Attribute	Type	Description
key	string	Key used for aggregation. This item is set only if the category is Consumer.
name	string	Name of the category used for aggregation. This item is set only if the category is Consumer.
critical	long	Number of criticals
warning	long	Number of warnings
total	long	Total

volumeSummary (Type: CategorySummary)

Attribute	Type	Description
key	string	Key used for aggregation. This item is set only if the category is Consumer.
name	string	Name of the category used for aggregation. This item is set only if the category is Consumer.
critical	long	Number of criticals
warning	long	Number of warnings
total	long	Total

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.
404	Not Found	The resource was not found.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.
503	Service Unavailable	Analyzer detail view server communication error.

Example code

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

[Request Body]
{
  "name": "getSystemStatusSummary",
  "href": "http://localhost:22015/Analytics/v1/services/SystemSummary/actions/getSystemStatusSummary/invoke",
  "method": "POST",
  "type": "application/json",
  "parameters":[]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 12 Aug 2016 02:18:54 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 3a9b57bff1fdbc16e83ca7fd4a2a9f6a7d542d_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" : "61a0f99c-c0ce-44e2-b1dd-0241b00
  "created" : "2016-08-12T11:18:54.628+09:00",
  "updated" : "2016-08-12T11:18:54.628+09:00",
  "completed" : "2016-08-12T11:18:54.628+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "status" : "NORMAL",
    "statusMessage" : "The system is normal",
    "messageHighlightParams" : [ ],
    "groupSummaries" : [ {
      "key" : "grade#Platinum",
      "name" : "Platinum",
      "critical" : 0,
      "warning" : 0,
      "total" : 0
    }, {
      "key" : "grade#Gold",
      "name" : "Gold",
      "critical" : 0,
      "warning" : 0,
      "total" : 0
    }, {
      "key" : "grade#Silver",
      "name" : "Silver",
      "critical" : 0,
      "warning" : 0,
      "total" : 0
    }, {
      "key" : "grade#Bronze",
      "name" : "Bronze",
      "critical" : 0,
      "warning" : 0,
      "total" : 0
    } ],
    "vmSummary" : {
      "critical" : 0,
      "warning" : 0,
      "total" : 59
    },
    "hostSummary" : {
      "critical" : 0,
      "warning" : 0,
      "total" : 0
    },
    "volumeSummary" : {
      "critical" : 0,
      "warning" : 0,
      "total" : 1570
    }
  } ]
}