VirtualClusterPlacementAdvice create request (Provider API)
Description
This API creates a VirtualClusterPlacementAdvice object.
API stability classification
API overview
HTTP | URI | Return | Return type |
---|---|---|---|
POST | csm/VirtualClusterPlacementAdvice/create |
|
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 objectsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
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:
|
operationParams | 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. |
The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
Input parameters to include in operationParamsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
Name | Type | Multi- | Description |
---|---|---|---|
computeSpecList | ComputeSpec | 1..* |
|
deploymentParameterValue | 0..* | List of deployment parameter values | |
placement_objects | 1..* | List of virtual cluster placement candidates | |
serviceOfferingInstanceUri | String | 0..1 | URI of the already provisioned ServiceOfferingInstance |
specResourceList | ComputeContainerSpec | 1..* | Specification resource list |
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.