vcenter cluster edrs maintenance mode: get
Get the status of the cluster maintenance mode. 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
GET https://{server}/rest/vcenter/cluster/{cluster}/edrs/maintenance-mode
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| cluster | string | Identifier of queried cluster. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"status" : "ENTERING_MAINTENANCE_MODE"
}
}
"value" : {
"status" : "ENTERING_MAINTENANCE_MODE"
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | info | The status of the cluster maintenance mode behaviors. |
| value.status | string | Cluster status related to the maintenance mode. 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. Defines the cluster status related to the maintenance mode. Warning: This enumeration 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. Value is one of: ENTERING_MAINTENANCE_MODE: Cluster is entering cluster maintenance mode. Warning: This constant 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. IN_MAINTENANCE_MODE: Cluster entered cluster maintenance mode and have not exited. Warning: This constant 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. EXITING_MAINTENANCE_MODE: Cluster is exiting cluster maintenance mode. Warning: This constant 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. NOT_IN_MAINTENANCE_MODE: Cluster has exited the maintenance mode. Warning: This constant 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. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if the cluster is not known. |
| 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. |