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 suspend request

Description

This API changes the state reported in the state attribute of the specified compute container to Suspended. It does not perform a suspend operation on the compute container. If you want to suspend the compute container, you must write a callout that implements suspension. You can either specify the callout in the preCallout object of the request message body JSON or statically link the callout to this operation.

The purpose of suspending a compute container is to stop the server and persist its state such that it can resume quickly and continue execution where it left off.

API stability classification

Unstable

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/ComputeContainer/guid/suspend

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

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.

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.

Comments