VirtualDatastorePlacementAdvice create request (Provider API)

Description

This API creates a VirtualDatastorePlacementAdvice object.

API stability classification

Unstable

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/VirtualDatastorePlacementAdvice/create

VirtualDatastorePlacementAdvice

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

operationParams

OperationParameter

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.

 
Input parameters to include in operationParams 

Name

Type

Multi-
plicity

Description

computeContainerUri

String

0..1

URI of the compute container to which the VM belongs. It can be used to implement compute container level affinity in placement algorithms.

computeSpecList

ComputeSpec

1..*

deploymentParameterValue

DeploymentParameterValue

0..*

List of deployment parameter values

diskSequenceCount

Integer

0..1

Index of the disk specification in the blueprint

diskSpec

DiskSpec

0..1

dSpec

DiskSpec

0..1

invokedForAnAlreadyProvisionedComputeContainer

Boolean

0..1

Indicates whether this operation is invoked for a compute container that has already been provisioned. Set to true for day 2 Add Disk use cases, otherwise not present or false.

placement_objects

VirtualDatastore

0..*

List of virtual data store placement candidates

serviceOfferingInstanceUri

String

0..1

URI of the service offering instance (SOI) to which the VM belongs. It can be used to implement SOI level affinity in placement algorithms.

specResourceList

ComputeContainerSpec

1..*

Compute container specification

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.

Was this page helpful? Yes No Submitting... Thank you

Comments