Mount Point: /api/v19/clusters/{clusterName}/services/{serviceName}/commands/offline


Offline roles of a service.

Currently the offline operation is only supported by HDFS.

For HDFS, the offline operation will put DataNodes into HDFS IN MAINTENANCE state which prevents unnecessary re-replication which could occur if decommissioned.

The timeout parameter is used to specify a timeout for offline. For HDFS, when the timeout expires, the DataNode will automatically transition out of HDFS IN MAINTENANCE state, back to HDFS IN SERVICE state.


name description type default
serviceName The service name. path
timeout Offline timeout in seconds. Offlined roles will automatically transition from offline state to normal state after timeout. Specify as null to get the default timeout (4 hours). query
clusterName (no documentation provided) path

Request Body

element: roleNames

List of role names to offline.

Response Body

element: command

Information about the submitted command.