2.8.3 Obtaining Virtual Machine Monitoring Status Change Information

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

Execution permission

Admin, Modify

API version

Request format

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

Request body

Not applicable.

Response body

The structure of the response 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 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	anyType[]	A list of ChangeManagedTypeParamForVM objects necessary to execute an operation. For details about ChangeManagedTypeParamForVM, see the table below.

ChangeManagedTypeParamForVM

{
        "newMonitoringOperationType":"...",
        "virtualMachineIds":["...", ...]
}

ChangeManagedTypeParamForVM (Type: ChangeManagedTypeParamForVM)

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
virtualMachineIds	long[]	Specify the ID for identifying the virtual machine. To specify multiple virtual machines, specify the IDs concurrently. To set virtual machines whose instanceID is 50 and 51, specify the settings as follows: virtualMachineIds : [ 50, 51 ]

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

virtualMachineIds

long[]

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

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

virtualMachineIds : [ 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/VirtualMachines/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/VirtualMachines/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitoringOperationType" : "Monitor",
    "virtualMachineIds" : [ ]
  } ]
}