LogicalHostingEnvironment acquireLock request
Description
Locks a LogicalHostingEnvironment
object to prevent parallel updates. This API should be executed before any updates to LogicalFirewallRule
or LogicalNetworkPath
within this environment. Once updates are complete, the LogicalHostingEnvironment
lock should be released using the releaseLock
API.
API stability classification
API overview
HTTP |
URI |
Return |
Return type |
---|---|---|---|
|
|
|
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 |
---|---|---|---|
|
|
0..1 |
URL to call when the operation finishes |
|
|
0..1 |
Identifier of a callout to run after the operation executes |
|
|
0..1 |
Identifier of a callout to run before the operation executes |
|
|
0..1 |
Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values:
|
|
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- |
Description |
---|---|---|---|
|
|
0..1 |
Maximum interval of time (in seconds) to wait to acquire the lock. Zero or a negative value is interpreted as an infinite interval. |
|
|
0..1 |
Interval of time in seconds after which the lock will automatically expire if not explicitly released until then. Zero or a negative value will be interpreted as an infinite interval. |
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.
Comments
Log in or register to comment.