Search or ask Docker

ContainerNetworkStats

ContainerNetworkStats schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Aggregates the network stats of one container
endpoint_id

Type: string

Endpoint ID. Not used on Linux.

This field is Windows-specific and omitted for Linux containers.

All schema constraints and annotations
{
  "description": "Endpoint ID. Not used on Linux.\n\nThis field is Windows-specific and omitted for Linux containers.\n",
  "type": "string",
  "x-nullable": true
}
instance_id

Type: string

Instance ID. Not used on Linux.

This field is Windows-specific and omitted for Linux containers.

All schema constraints and annotations
{
  "description": "Instance ID. Not used on Linux.\n\nThis field is Windows-specific and omitted for Linux containers.\n",
  "type": "string",
  "x-nullable": true
}
rx_bytes

Type: integer

Bytes received. Windows and Linux.
All schema constraints and annotations
{
  "description": "Bytes received. Windows and Linux.\n",
  "example": 5338,
  "format": "uint64",
  "type": "integer"
}
rx_dropped

Type: integer

Incoming packets dropped. Windows and Linux.
All schema constraints and annotations
{
  "description": "Incoming packets dropped. Windows and Linux.\n",
  "example": 0,
  "format": "uint64",
  "type": "integer"
}
rx_errors

Type: integer

Received errors. Not used on Windows.

This field is Linux-specific and always zero for Windows containers.

All schema constraints and annotations
{
  "description": "Received errors. Not used on Windows.\n\nThis field is Linux-specific and always zero for Windows containers.\n",
  "example": 0,
  "format": "uint64",
  "type": "integer"
}
rx_packets

Type: integer

Packets received. Windows and Linux.
All schema constraints and annotations
{
  "description": "Packets received. Windows and Linux.\n",
  "example": 36,
  "format": "uint64",
  "type": "integer"
}
tx_bytes

Type: integer

Bytes sent. Windows and Linux.
All schema constraints and annotations
{
  "description": "Bytes sent. Windows and Linux.\n",
  "example": 1200,
  "format": "uint64",
  "type": "integer"
}
tx_dropped

Type: integer

Outgoing packets dropped. Windows and Linux.
All schema constraints and annotations
{
  "description": "Outgoing packets dropped. Windows and Linux.\n",
  "example": 0,
  "format": "uint64",
  "type": "integer"
}
tx_errors

Type: integer

Sent errors. Not used on Windows.

This field is Linux-specific and always zero for Windows containers.

All schema constraints and annotations
{
  "description": "Sent errors. Not used on Windows.\n\nThis field is Linux-specific and always zero for Windows containers.\n",
  "example": 0,
  "format": "uint64",
  "type": "integer"
}
tx_packets

Type: integer

Packets sent. Windows and Linux.
All schema constraints and annotations
{
  "description": "Packets sent. Windows and Linux.\n",
  "example": 12,
  "format": "uint64",
  "type": "integer"
}
All schema constraints and annotations
{
  "description": "Aggregates the network stats of one container\n",
  "properties": {
    "endpoint_id": {
      "description": "Endpoint ID. Not used on Linux.\n\nThis field is Windows-specific and omitted for Linux containers.\n",
      "type": "string",
      "x-nullable": true
    },
    "instance_id": {
      "description": "Instance ID. Not used on Linux.\n\nThis field is Windows-specific and omitted for Linux containers.\n",
      "type": "string",
      "x-nullable": true
    },
    "rx_bytes": {
      "description": "Bytes received. Windows and Linux.\n",
      "example": 5338,
      "format": "uint64",
      "type": "integer"
    },
    "rx_dropped": {
      "description": "Incoming packets dropped. Windows and Linux.\n",
      "example": 0,
      "format": "uint64",
      "type": "integer"
    },
    "rx_errors": {
      "description": "Received errors. Not used on Windows.\n\nThis field is Linux-specific and always zero for Windows containers.\n",
      "example": 0,
      "format": "uint64",
      "type": "integer"
    },
    "rx_packets": {
      "description": "Packets received. Windows and Linux.\n",
      "example": 36,
      "format": "uint64",
      "type": "integer"
    },
    "tx_bytes": {
      "description": "Bytes sent. Windows and Linux.\n",
      "example": 1200,
      "format": "uint64",
      "type": "integer"
    },
    "tx_dropped": {
      "description": "Outgoing packets dropped. Windows and Linux.\n",
      "example": 0,
      "format": "uint64",
      "type": "integer"
    },
    "tx_errors": {
      "description": "Sent errors. Not used on Windows.\n\nThis field is Linux-specific and always zero for Windows containers.\n",
      "example": 0,
      "format": "uint64",
      "type": "integer"
    },
    "tx_packets": {
      "description": "Packets sent. Windows and Linux.\n",
      "example": 12,
      "format": "uint64",
      "type": "integer"
    }
  },
  "type": "object",
  "x-go-name": "NetworkStats",
  "x-nullable": true
}