rest-api-spec.api.indices.disk_usage.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

Elasticsearch subproject :rest-api-spec

The newest version!

{
  "indices.disk_usage": {
    "documentation": {
      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-disk-usage.html",
      "description": "Analyzes the disk usage of each field of an index or data stream"
    },
    "stability": "experimental",
    "visibility": "public",
    "headers": {
      "accept": [
        "application/json"
      ]
    },
    "url": {
      "paths": [
        {
          "path": "/{index}/_disk_usage",
          "methods": [
            "POST"
          ],
          "parts": {
            "index": {
              "type": "string",
              "description": "Comma-separated list of indices or data streams to analyze the disk usage"
            }
          }
        }
      ]
    },
    "params": {
      "run_expensive_tasks": {
        "type": "boolean",
        "description": "Must be set to [true] in order for the task to be performed. Defaults to false."
      },
      "flush": {
        "type": "boolean",
        "description": "Whether flush or not before analyzing the index disk usage. Defaults to true"
      },
      "ignore_unavailable": {
        "type": "boolean",
        "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
      },
      "allow_no_indices": {
        "type": "boolean",
        "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"
      },
      "expand_wildcards": {
        "type": "enum",
        "options": [
          "open",
          "closed",
          "hidden",
          "none",
          "all"
        ],
        "default": "open",
        "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
      }
    }
  }
}