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
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/ComputeContainer/guid/fence | 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- | 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:
|
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: bmc-safe-include. Click on this message for details.