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

Query string parameters

This API does not use query string parameters.

Request message headers

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

Request message body

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

HTTP response message

Response message headers

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

Response message body

The response message body contains a Task object.

Unknown macro: confluence_report-block. Click on this message for details.

Related topics

HTTP-messages
JSON-object-types

 

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