rest-api-spec.api.remote_store.stats.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

OpenSearch subproject :rest-api-spec

The newest version!

{
  "remote_store.stats":{
    "documentation":{
      "url": "https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api/",
      "description":"Stats for remote store."
    },
    "stability":"experimental",
    "url":{
      "paths":[
        {
          "path":"/_remotestore/stats/{index}",
          "methods":[
            "GET"
          ],
          "parts":{
            "index":{
              "type":"string",
              "description": "Index name to fetch stats"
            }
          }
        },
        {
          "path":"/_remotestore/stats/{index}/{shard_id}",
          "methods":[
            "GET"
          ],
          "parts":{
            "index":{
              "type":"string",
              "description":"Index name to fetch stats"
            },
            "shard_id":{
              "type":"string",
              "description":"Specific shard to fetch stats"
            }
          }
        }
      ]
    },
    "params":{
      "timeout":{
        "type":"time",
        "default":"10s",
        "description":"Max time each individual stats request should take."
      }
    }
  }
}