ComputeContainer start request

Description

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

API stability classification

API overview

HTTP method	URI	Return type	Return type multiplicity
`POST`	`csm/ComputeContainer/guid/start`	`void`	Not applicable

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 objects

Name	Type	Multi- plicity	Description
`callbackURL`	`String`	0..1	URL to call when the operation finishes
`postCallout`	`String`	0..1	Identifier of a callout to run after the operation executes
`preCallout`	`String`	0..1	Identifier of a callout to run before the operation executes
`timeout`	`Integer`	0..1	Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values: 0: Immediate timeout -1: Uses the system default timeout value 1..*: Times out in the specified number of seconds
`operationParams`	`OperationParameter`	1	Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing input parameters with an API request.

Input parameters to include in operationParams

Name	Type	Multi- plicity	Description
`LogicalDataCenterId`	`String`	0..1	Logical data center identifier
`serviceOfferingInstance`	`ServiceOfferingInstance`	0..1	Service offering instance

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 request that starts the compute container or VM.

URL Syntax: /csm/ComputeContainer/guid/start
{
"timeout":-1,
"preCallout":"",
"postCallout":"",
"callbackURL":""
}

The following example shows an HTTP response that starts 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/start

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