ray.util.state.common.NodeState#

class ray.util.state.common.NodeState(node_id: str, node_ip: str, is_head_node: bool, state: Literal['ALIVE', 'DEAD'], state_message: str | None, node_name: str, resources_total: dict, labels: dict, start_time_ms: int | None = None, end_time_ms: int | None = None)[source]#

Bases: StateSchema

Node State

Below columns can be used for the --filter option.

node_id

node_ip

is_head_node

node_name

state

Below columns are available only when get API is used,

--detail is specified through CLI, or detail=True is given to Python APIs.

node_id

node_ip

start_time_ms

is_head_node

state_message

labels

resources_total

node_name

end_time_ms

state

node_id: str#: The id of the node.

node_ip: str#: The ip address of the node.

is_head_node: bool#: If this is a head node.

state: Literal['ALIVE', 'DEAD']#

The state of the node.

ALIVE: The node is alive. DEAD: The node is dead.

state_message: str | None#: The state message of the node. This provides more detailed information about the node’s state.

node_name: str#: The name of the node if it is given by the name argument.

resources_total: dict#: The total resources of the node.

labels: dict#: The labels of the node.

start_time_ms: int | None = None#: The time when the node (raylet) starts.