2.17.4 Changing Virtual Machine Monitoring Status
This API changes the monitoring status of virtual machines.
Execution permission
Admin, Modify
API version
v1
Request format
POST http[s]://host:port/Analytics/version/services/VirtualMachines/actions/changeManagedType/invoke
Request body
The structure of the request body and the object attributes are as follows:{ "name":"...", "href":"...", "method":"...", "type":"...", "parameters":[{ "newMonitoringOperationType":"...", "virtualMachineIds":["...", ...] }, : ] }
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 |
ChangeManagedTypeParamForVM[] |
A list of ChangeManagedTypeParamForVM objects necessary to execute an operation. For details about ChangeManagedTypeParamForVM, see the table below. |
parameters (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:
|
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 ] |
Response body
The structure of the response body and the object attributes are as follows:{ "instanceID":"...", "created":"...", "updated":"...", "completed":"...", "state":"...", "affectedResource":["...", ...], "result":["...", ...] }
Job (Type: Job)
Attribute |
Type |
Description |
---|---|---|
instanceID |
string |
Indicates the ID of the Instance. |
created |
string |
Indicates the date the object is generated in ISO 8601 format. |
updated |
string |
Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set. |
completed |
string |
Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set. |
state |
string |
One of the following values is set: "failed": The operation did not terminate normally. "success": The operation terminated normally. |
affectedResource |
string[] |
Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty. |
result |
anyType[] |
A list of objects. No value is set. |
Status codes
Status code |
Reason phrase |
Description |
---|---|---|
200 |
OK |
Success. |
400 |
Bad Request |
A format of 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/VirtualMachines/actions/changeManagedType/invoke HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: curl/7.33.0 Host: localhost:22015 Accept: application/json Content-Type: application/json Accept-Language: ja Content-Length: 296 [Request Body] { "name" : "changeManagedType", "href" : "http://localhost:22015/Analytics/v1/services/VirtualMachines/actions/changeManagedType/invoke", "method" : "POST", "type" : "application/json", "parameters" : [ { "newMonitoringOperationType" : "Ignore", "virtualMachineIds" : [ 31, 80 ] } ] } [Response Header] HTTP/1.1 200 OK Date: Fri, 27 Nov 2015 09:22:28 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7", "created" : "2015-11-27T18:22:28.528+09:00", "updated" : "2015-11-27T18:22:28.647+09:00", "completed" : "2015-11-27T18:22:28.647+09:00", "state" : "success", "affectedResource" : [ ], "result" : [ ] }