Search or ask Docker

ClusterInfo

ClusterInfo schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

ClusterInfo represents information about the swarm as is returned by the "/info" endpoint. Join-tokens are not included.
CreatedAt

Type: string

Date and time at which the swarm was initialised in RFC 3339 format with nano-seconds.
All schema constraints and annotations
{
  "description": "Date and time at which the swarm was initialised in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
  "example": "2016-08-18T10:44:24.496525531Z",
  "format": "dateTime",
  "type": "string"
}
DataPathPort

Type: integer

DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used.
All schema constraints and annotations
{
  "default": 4789,
  "description": "DataPathPort specifies the data path port number for data traffic.\nAcceptable port range is 1024 to 49151.\nIf no port is set or is set to 0, the default port (4789) is used.\n",
  "example": 4789,
  "format": "uint32",
  "type": "integer"
}
DefaultAddrPool

Type: array

Default Address Pool specifies default subnet pools for global scope networks.
Array item

Type: string

All schema constraints and annotations
{
  "example": [
    "10.10.0.0/16",
    "20.20.0.0/16"
  ],
  "format": "CIDR",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "Default Address Pool specifies default subnet pools for global scope\nnetworks.\n",
  "items": {
    "example": [
      "10.10.0.0/16",
      "20.20.0.0/16"
    ],
    "format": "CIDR",
    "type": "string"
  },
  "type": "array"
}
ID

Type: string

The ID of the swarm.
All schema constraints and annotations
{
  "description": "The ID of the swarm.",
  "example": "abajmipo7b4xz5ip2nrla6b11",
  "type": "string"
}
RootRotationInProgress

Type: boolean

Whether there is currently a root CA rotation in progress for the swarm
All schema constraints and annotations
{
  "description": "Whether there is currently a root CA rotation in progress for the swarm\n",
  "example": false,
  "type": "boolean"
}
Spec

Schema: SwarmSpec

SubnetSize

Type: integer

SubnetSize specifies the subnet size of the networks created from the default subnet pool.
All schema constraints and annotations
{
  "default": 24,
  "description": "SubnetSize specifies the subnet size of the networks created from the\ndefault subnet pool.\n",
  "example": 24,
  "format": "uint32",
  "maximum": 29,
  "type": "integer"
}
TLSInfo

Schema: TLSInfo

UpdatedAt

Type: string

Date and time at which the swarm was last updated in RFC 3339 format with nano-seconds.
All schema constraints and annotations
{
  "description": "Date and time at which the swarm was last updated in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
  "example": "2017-08-09T07:09:37.632105588Z",
  "format": "dateTime",
  "type": "string"
}
Version

Schema: ObjectVersion

All schema constraints and annotations
{
  "description": "ClusterInfo represents information about the swarm as is returned by the\n\"/info\" endpoint. Join-tokens are not included.\n",
  "properties": {
    "CreatedAt": {
      "description": "Date and time at which the swarm was initialised in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
      "example": "2016-08-18T10:44:24.496525531Z",
      "format": "dateTime",
      "type": "string"
    },
    "DataPathPort": {
      "default": 4789,
      "description": "DataPathPort specifies the data path port number for data traffic.\nAcceptable port range is 1024 to 49151.\nIf no port is set or is set to 0, the default port (4789) is used.\n",
      "example": 4789,
      "format": "uint32",
      "type": "integer"
    },
    "DefaultAddrPool": {
      "description": "Default Address Pool specifies default subnet pools for global scope\nnetworks.\n",
      "items": {
        "example": [
          "10.10.0.0/16",
          "20.20.0.0/16"
        ],
        "format": "CIDR",
        "type": "string"
      },
      "type": "array"
    },
    "ID": {
      "description": "The ID of the swarm.",
      "example": "abajmipo7b4xz5ip2nrla6b11",
      "type": "string"
    },
    "RootRotationInProgress": {
      "description": "Whether there is currently a root CA rotation in progress for the swarm\n",
      "example": false,
      "type": "boolean"
    },
    "Spec": {
      "$ref": "#/components/schemas/SwarmSpec"
    },
    "SubnetSize": {
      "default": 24,
      "description": "SubnetSize specifies the subnet size of the networks created from the\ndefault subnet pool.\n",
      "example": 24,
      "format": "uint32",
      "maximum": 29,
      "type": "integer"
    },
    "TLSInfo": {
      "$ref": "#/components/schemas/TLSInfo"
    },
    "UpdatedAt": {
      "description": "Date and time at which the swarm was last updated in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
      "example": "2017-08-09T07:09:37.632105588Z",
      "format": "dateTime",
      "type": "string"
    },
    "Version": {
      "$ref": "#/components/schemas/ObjectVersion"
    }
  },
  "type": "object",
  "x-nullable": true
}