rest-api-spec.api.snapshot.repository_analyze.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

There is a newer version: 8.16.0

{
  "snapshot.repository_analyze":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html",
      "description":"Analyzes a repository for correctness and performance"
    },
    "stability":"stable",
    "visibility":"public",
    "headers": {
      "accept": [
        "application/json"
      ]
    },
    "url":{
      "paths":[
        {
          "path":"/_snapshot/{repository}/_analyze",
          "methods":[
            "POST"
          ],
          "parts":{
            "repository":{
              "type":"string",
              "description":"A repository name"
            }
          }
        }
      ]
    },
    "params":{
      "blob_count":{
        "type":"number",
        "description":"Number of blobs to create during the test. Defaults to 100."
      },
      "concurrency":{
        "type":"number",
        "description":"Number of operations to run concurrently during the test. Defaults to 10."
      },
      "read_node_count":{
        "type":"number",
        "description":"Number of nodes on which to read a blob after writing. Defaults to 10."
      },
      "early_read_node_count":{
        "type":"number",
        "description":"Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2."
      },
      "seed":{
        "type":"number",
        "description":"Seed for the random number generator used to create the test workload. Defaults to a random value."
      },
      "rare_action_probability":{
        "type":"number",
        "description":"Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02."
      },
      "max_blob_size":{
        "type":"string",
        "description":"Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'."
      },
      "max_total_data_size":{
        "type":"string",
        "description":"Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'."
      },
      "timeout":{
        "type":"time",
        "description":"Explicit operation timeout. Defaults to '30s'."
      },
      "detailed":{
        "type":"boolean",
        "description":"Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned."
      },
      "rarely_abort_writes":{
        "type":"boolean",
        "description":"Whether to rarely abort writes before they complete. Defaults to 'true'."
      }
    }
  }
}