Unsupported content

 

This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

LogicalHostingEnvironment reprovision request

Description

Re-provisions the LogicalHostingEnvironment to adhere to a newer version of a LogicalHostingEnvironmentBlueprint.

API stability classification

Unassigned

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/LogicalHostingEnvironment/guid/reprovision

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-
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

failOnNoRollback

Boolean

0..1

During the re-provision operation, the new LogicalHostingEnvironmentBlueprint dictates the set of actions that must be performed on the existing LogicalHostingEnvironment. Amongst these, there may be a set of actions taken that can be reverted and a set of actions that cannot.
In the former case, if a failure occurs during re-provisioning, the LogicalHostingEnvironment will be safely reverted to it's original state prior to re-provisioning.
In the latter case, if a failure occurs during re-provisioning, the LogicalHostingEnvironment could end up in an inconsistent state.
The failOnNoRollback, if set to true, will prevent the re-provision operation from executing if there are any actions that cannot be reverted. In this case, the re-provision operation will fail.

lheBlueprintGuid

String

1

The ID of the new LogicalHostingEnvironmentBlueprint object.

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.

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments