vcenter cluster edrs maintenance mode: enter-task
Request the cluster to enter the maintenance mode, EDRS would generate the scaling recommendation based on cluster resources utilization. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Request:
HTTP request
POST https://{server}/rest/vcenter/cluster/{cluster}/edrs/maintenance-mode?vmw-task=true&action=enter
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| cluster | string | Identifier of cluster that entering maintenance mode. |
Request Body Structure:
{
"spec" : {
"timeout" : 1
}
}
"spec" : {
"timeout" : 1
}
}
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| spec | enter_spec | Entering cluster maintenance mode specification. |
| spec.timeout | long | Action Timeout value in seconds. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset cluster does not have a timeout limit when entering maintenance mode. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : "obj-103"
}
"value" : "obj-103"
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | string | |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 400 | not_allowed_in_current_state | if the cluster has already been in the maintenance mode. |
| 404 | not_found | if the cluster is not known. |
| 500 | timed_out | if entering maintenance mode behavior is timed out. |
| 403 | unauthorized | if the user doesn't have the required privileges. |
| 500 | error | if there is some unknown internal error. The accompanying error message will give more details about the error. |