HostsResource Resource

DELETE /hosts

Delete all hosts in the system

GET /hosts

Returns the hostIds for all hosts in the system.

POST /hosts

Create one or more hosts.

You must specify at least the hostname and ipAddress in the request objects. If no hostId is specified, it will be set to the hostname. It is an error to try and create host with the same hostId as another host.

DELETE /hosts/{hostId}

Delete a host from the system

GET /hosts/{hostId}

Returns a specific Host in the system

GET /hosts/{hostId}

Returns a specific Host in the system.

PUT /hosts/{hostId}

Update an existing host in the system.

Currently, only updating the rackId is supported. All other fields of the host will be ignored.

GET /hosts/{hostId}/config

Retrieves the configuration of a specific host.

PUT /hosts/{hostId}/config

Updates the host configuration with the given values.

If a value is set in the given configuration, it will be added to the host's configuration, replacing any existing entries. If a value is unset (its value is null), the existing configuration for the attribute will be erased, if any.

Attributes that are not listed in the input will maintain their current values in the configuration.

GET /hosts/{hostId}/metrics

Fetch metric readings for a host.

By default, this call will look up all metrics available for the host. If only specific metrics are desired, use the metrics parameter.

By default, the returned results correspond to a 5 minute window based on the provided end time (which defaults to the current server time). The from and to parameters can be used to control the window being queried. A maximum window of 3 hours is enforced.

When requesting a "full" view, aside from the extended properties of the returned metric data, the collection will also contain information about all metrics available for the role, even if no readings are available in the requested window.

Host metrics also include per-network interface and per-storage device metrics. Since collecting this data incurs in more overhead, query parameters can be used to choose which network interfaces and storage devices to query, or to these metrics altogether.

Storage metrics are collected at different levels; for example, per-disk and per-partition metrics are available. The "storageIds" parameter can be used to filter specific storage IDs.

In the returned data, the network interfaces and storage IDs can be identified by looking at the "context" property of the metric objects.

POST /hosts/{hostId}/commands/enterMaintenanceMode

Put the host into maintenance mode. This is a synchronous command. The result is known immediately upon return.

Available since API v2.

POST /hosts/{hostId}/commands/exitMaintenanceMode

Take the host out of maintenance mode. This is a synchronous command. The result is known immediately upon return.

Available since API v2.

POST /hosts/{hostId}/commands/generateHostCerts

Generates (or regenerates) a key and certificate for this host if Auto-TLS is enabled.

POST /hosts/{hostId}/commands/migrateRoles

Migrate roles to a different host.

This command applies only to HDFS NameNode, JournalNode, and Failover Controller roles. In order to migrate these roles:

• HDFS High Availability must be enabled, using quorum-based storage.
• HDFS must not be configured to use a federated nameservice.

If the active NameNode is selected for migration, a manual failover will be performed before the role is migrated. The role will remain in standby mode after the migration is complete.

When migrating a NameNode role, the co-located Failover Controller role must be migrated as well if automatic failover is enabled. The Failover Controller role name must be included in the list of role names to migrate specified in the arguments to this command (it will not be included implicitly). This command does not allow a Failover Controller role to be moved by itself, although it is possible to move a JournalNode independently.

Available since API v10.