Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


2.14.3 Obtaining Pod Monitoring Status Change Information

This API acquires information required for changing the monitoring status of pod.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Pods/actions/changeManagedType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:
{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitoringOperationType":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForPod[]

A list of ChangeManagedTypeParamForPod objects necessary to execute an operation. For details about ChangeManagedTypeParamForPod, see the table below.

parameters (Type: ChangeManagedTypeParamForPod)

Attribute

Type

Description

newMonitoringOperationType

enum

Specify the monitoring status to be changed to.

(For details about the specifiable values, see the table MonitoringOperationType in List of enumerators.)

The specifiable values are as follows:

  • Monitor
  • Ignore

ids

long[]

Specify the ID for identifying the pod. To specify multiple virtual machines, specify the IDs concurrently.

To set pods whose instanceID is 50 and 51, specify the settings as follows:

ids : [ 50, 51 ]

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/services/Pods/actions HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/Pods/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitoringOperationType" : "Monitor",
    "ids" : [ ]
  } ]
}