Search or ask Docker

VolumesDiskUsage

VolumesDiskUsage schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

represents system data usage for volume resources.
ActiveCount

Type: integer

Count of active volumes.
All schema constraints and annotations
{
  "description": "Count of active volumes.\n",
  "example": 1,
  "format": "int64",
  "type": "integer"
}
Items

Type: array

List of volumes.
Array item
All schema constraints and annotations
{
  "x-go-type": {
    "type": "Volume"
  }
}
All schema constraints and annotations
{
  "description": "List of volumes.\n",
  "items": {
    "x-go-type": {
      "type": "Volume"
    }
  },
  "type": "array",
  "x-omitempty": true
}
Reclaimable

Type: integer

Disk space that can be reclaimed by removing inactive volumes.
All schema constraints and annotations
{
  "description": "Disk space that can be reclaimed by removing inactive volumes.\n",
  "example": 12345678,
  "format": "int64",
  "type": "integer"
}
TotalCount

Type: integer

Count of all volumes.
All schema constraints and annotations
{
  "description": "Count of all volumes.\n",
  "example": 4,
  "format": "int64",
  "type": "integer"
}
TotalSize

Type: integer

Disk space in use by volumes.
All schema constraints and annotations
{
  "description": "Disk space in use by volumes.\n",
  "example": 98765432,
  "format": "int64",
  "type": "integer"
}
All schema constraints and annotations
{
  "description": "represents system data usage for volume resources.\n",
  "properties": {
    "ActiveCount": {
      "description": "Count of active volumes.\n",
      "example": 1,
      "format": "int64",
      "type": "integer"
    },
    "Items": {
      "description": "List of volumes.\n",
      "items": {
        "x-go-type": {
          "type": "Volume"
        }
      },
      "type": "array",
      "x-omitempty": true
    },
    "Reclaimable": {
      "description": "Disk space that can be reclaimed by removing inactive volumes.\n",
      "example": 12345678,
      "format": "int64",
      "type": "integer"
    },
    "TotalCount": {
      "description": "Count of all volumes.\n",
      "example": 4,
      "format": "int64",
      "type": "integer"
    },
    "TotalSize": {
      "description": "Disk space in use by volumes.\n",
      "example": 98765432,
      "format": "int64",
      "type": "integer"
    }
  },
  "type": "object",
  "x-go-name": "DiskUsage",
  "x-go-package": "github.com/moby/moby/api/types/volume"
}