LogicalLoadBalancerPlacementAdvice create request (Provider API)

Description

This API performs a placement decision from amongst a set of eligible LogicalLoadBalancer objects.

API stability classification

Unstable

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/LogicalLoadBalancerPlacementAdvice/create

LogicalLoadBalancerPlacementAdvice

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

adviceEvalCriteriaList

CloudObject

1..*

List of advice evaluation criteria. The list must contain the following objects:
Index 0: ResourceSetSpec object
Index 1: Organization object
Index 2: DeploymentModelSpec object
Index 3: FunctionalModelSpec object

deploymentParameterValue

DeploymentParameterValue

0..*

List of deployment parameter values

placement_objects

LogicalLoadBalancer

1..*

List of eligible LogicalLoadBalancer objects amongst which the a selection may be made

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