ComputeContainer fence request

Description

This API changes the state reported in the state attribute of the specified compute container to Fenced. It does not perform a fence operation on the compute container. If you want to fence the compute container, you must write a callout that implements fencing. 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 fencing a compute container is to shield it from the network by making it unable to receive incoming connection requests or make outbound connection requests.

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 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
The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

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.
Unknown macro: confluence_report-block. Click on this message for details.
The [confluence_report-block] macro is not in the list of registered macros. Verify the spelling or contact your administrator.