elasticsearch-js/docs/reference/api/Nodes.md

Nodes

Constructor

::: new Nodes(transport: Transport); :::

Properties

Name	Type	Description
acceptedParams	Record<string, { path: string[]; body: string[]; query: string[]; }>
transport	Transport

Methods

Name	Signature	Description
clearRepositoriesMeteringArchive	clearRepositoriesMeteringArchive(this: [That](./That.md), params: [NodesClearRepositoriesMeteringArchiveRequest](./NodesClearRepositoriesMeteringArchiveRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesClearRepositoriesMeteringArchiveResponse](./NodesClearRepositoriesMeteringArchiveResponse.md)>;	Clear the archived repositories metering. Clear the archived repositories metering information in the cluster.
clearRepositoriesMeteringArchive	clearRepositoriesMeteringArchive(this: [That](./That.md), params: [NodesClearRepositoriesMeteringArchiveRequest](./NodesClearRepositoriesMeteringArchiveRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesClearRepositoriesMeteringArchiveResponse](./NodesClearRepositoriesMeteringArchiveResponse.md), unknown>>;
clearRepositoriesMeteringArchive	clearRepositoriesMeteringArchive(this: [That](./That.md), params: [NodesClearRepositoriesMeteringArchiveRequest](./NodesClearRepositoriesMeteringArchiveRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesClearRepositoriesMeteringArchiveResponse](./NodesClearRepositoriesMeteringArchiveResponse.md)>;
getRepositoriesMeteringInfo	getRepositoriesMeteringInfo(this: [That](./That.md), params: [NodesGetRepositoriesMeteringInfoRequest](./NodesGetRepositoriesMeteringInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesGetRepositoriesMeteringInfoResponse](./NodesGetRepositoriesMeteringInfoResponse.md)>;	Get cluster repositories metering. Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.
getRepositoriesMeteringInfo	getRepositoriesMeteringInfo(this: [That](./That.md), params: [NodesGetRepositoriesMeteringInfoRequest](./NodesGetRepositoriesMeteringInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesGetRepositoriesMeteringInfoResponse](./NodesGetRepositoriesMeteringInfoResponse.md), unknown>>;
getRepositoriesMeteringInfo	getRepositoriesMeteringInfo(this: [That](./That.md), params: [NodesGetRepositoriesMeteringInfoRequest](./NodesGetRepositoriesMeteringInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesGetRepositoriesMeteringInfoResponse](./NodesGetRepositoriesMeteringInfoResponse.md)>;
hotThreads	hotThreads(this: [That](./That.md), params?: [NodesHotThreadsRequest](./NodesHotThreadsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesHotThreadsResponse](./NodesHotThreadsResponse.md)>;	Get the hot threads for nodes. Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node.
hotThreads	hotThreads(this: [That](./That.md), params?: [NodesHotThreadsRequest](./NodesHotThreadsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesHotThreadsResponse](./NodesHotThreadsResponse.md), unknown>>;
hotThreads	hotThreads(this: [That](./That.md), params?: [NodesHotThreadsRequest](./NodesHotThreadsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesHotThreadsResponse](./NodesHotThreadsResponse.md)>;
info	info(this: [That](./That.md), params?: [NodesInfoRequest](./NodesInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesInfoResponse](./NodesInfoResponse.md)>;	Get node information. By default, the API returns all attributes and core settings for cluster nodes.
info	info(this: [That](./That.md), params?: [NodesInfoRequest](./NodesInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesInfoResponse](./NodesInfoResponse.md), unknown>>;
info	info(this: [That](./That.md), params?: [NodesInfoRequest](./NodesInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesInfoResponse](./NodesInfoResponse.md)>;
reloadSecureSettings	reloadSecureSettings(this: [That](./That.md), params?: [NodesReloadSecureSettingsRequest](./NodesReloadSecureSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesReloadSecureSettingsResponse](./NodesReloadSecureSettingsResponse.md)>;	Reload the keystore on nodes in the cluster. Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.
reloadSecureSettings	reloadSecureSettings(this: [That](./That.md), params?: [NodesReloadSecureSettingsRequest](./NodesReloadSecureSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesReloadSecureSettingsResponse](./NodesReloadSecureSettingsResponse.md), unknown>>;
reloadSecureSettings	reloadSecureSettings(this: [That](./That.md), params?: [NodesReloadSecureSettingsRequest](./NodesReloadSecureSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesReloadSecureSettingsResponse](./NodesReloadSecureSettingsResponse.md)>;
stats	stats(this: [That](./That.md), params?: [NodesStatsRequest](./NodesStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesStatsResponse](./NodesStatsResponse.md)>;	Get node statistics. Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics.
stats	stats(this: [That](./That.md), params?: [NodesStatsRequest](./NodesStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesStatsResponse](./NodesStatsResponse.md), unknown>>;
stats	stats(this: [That](./That.md), params?: [NodesStatsRequest](./NodesStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesStatsResponse](./NodesStatsResponse.md)>;
usage	usage(this: [That](./That.md), params?: [NodesUsageRequest](./NodesUsageRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesUsageResponse](./NodesUsageResponse.md)>;	Get feature usage information.
usage	usage(this: [That](./That.md), params?: [NodesUsageRequest](./NodesUsageRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesUsageResponse](./NodesUsageResponse.md), unknown>>;
usage	usage(this: [That](./That.md), params?: [NodesUsageRequest](./NodesUsageRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesUsageResponse](./NodesUsageResponse.md)>;