Search or ask Docker

NodeStatus

NodeStatus schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

NodeStatus represents the status of a node.

It provides the current status of the node, as seen by the manager.

Addr

Type: string

IP address of the node.
All schema constraints and annotations
{
  "description": "IP address of the node.",
  "example": "172.17.0.2",
  "type": "string"
}
Message

Type: string

All schema constraints and annotations
{
  "example": "",
  "type": "string"
}
State

Schema: NodeState

All schema constraints and annotations
{
  "description": "NodeStatus represents the status of a node.\n\nIt provides the current status of the node, as seen by the manager.\n",
  "properties": {
    "Addr": {
      "description": "IP address of the node.",
      "example": "172.17.0.2",
      "type": "string"
    },
    "Message": {
      "example": "",
      "type": "string"
    },
    "State": {
      "$ref": "#/components/schemas/NodeState"
    }
  },
  "type": "object"
}