Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

ComputeContainer stop request


Description

This API stops the computer container specified by the guid in the URI.

API stability classification

Committed

API overview

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objectsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.

Input parameters to include in operationParamsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.

HTTP response message

Response message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Response message body

The response message body contains a Task object.

Example

The following example shows an HTTP response that stops the compute container or VM.

Note

"$$*$$" are the escape characters representing the data that will vary depending on the target setup.

URL Syntax: /csm/ComputeContainer/guid_ComputeContainer/stop

[
 {
   "cloudClass": "com.bmc.cloud.model.beans.Task",
   "className": "ComputeContainer",
   "completionTime": "$$*$$",
   "creationTime": "$$*$$",
   "errors": "$$*$$",
   "guid": "$$*$$",
   "isCallout": false,
   "isError": false,
   "isSuccess": true,
   "operationName": "stop",
   "parentTaskInternalUUID": "$$*$$",
   "results": "$$*$$",
   "taskInternalUUID": "$$*$$",
   "taskProgress": "$$*$$",
   "taskResultURI": "$$*$$",
   "taskState": "COMPLETED",
   "taskStatusURI": "$$*$$",
   "taskSubState": "task_success_final",
   "transactionID": "$$*$$"
 }
]

 

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*