Search or ask Docker

ContainerThrottlingData

ContainerThrottlingData schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

CPU throttling stats of the container.

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

periods

Type: integer

Number of periods with throttling active.
All schema constraints and annotations
{
  "description": "Number of periods with throttling active.\n",
  "example": 0,
  "format": "uint64",
  "type": "integer"
}
throttled_periods

Type: integer

Number of periods when the container hit its throttling limit.
All schema constraints and annotations
{
  "description": "Number of periods when the container hit its throttling limit.\n",
  "example": 0,
  "format": "uint64",
  "type": "integer"
}
throttled_time

Type: integer

Aggregated time (in nanoseconds) the container was throttled for.
All schema constraints and annotations
{
  "description": "Aggregated time (in nanoseconds) the container was throttled for.\n",
  "example": 0,
  "format": "uint64",
  "type": "integer"
}
All schema constraints and annotations
{
  "description": "CPU throttling stats of the container.\n\nThis type is Linux-specific and omitted for Windows containers.\n",
  "properties": {
    "periods": {
      "description": "Number of periods with throttling active.\n",
      "example": 0,
      "format": "uint64",
      "type": "integer"
    },
    "throttled_periods": {
      "description": "Number of periods when the container hit its throttling limit.\n",
      "example": 0,
      "format": "uint64",
      "type": "integer"
    },
    "throttled_time": {
      "description": "Aggregated time (in nanoseconds) the container was throttled for.\n",
      "example": 0,
      "format": "uint64",
      "type": "integer"
    }
  },
  "type": "object",
  "x-go-name": "ThrottlingData",
  "x-nullable": true
}