Get snapshot information | Elasticsearch API documentation

Get component templates Generally available; Added in 5.1.0

GET /_cat/component_templates/{name}

All methods and paths for this operation:

GET /_cat/component_templates

GET /_cat/component_templates/{name}

Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.

Required authorization

Cluster privileges: monitor

Path parameters

name string Required

The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.

Query parameters

h string | array[string]
A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:
- name (or n): The name of the component template.
- version (or v): The version number of the component template.
- alias_count (or a): The number of aliases in the component template.
- mapping_count (or m): The number of mappings in the component template.
- settings_count (or s): The number of settings in the component template.
- metadata_count (or me): The number of metadata entries in the component template.
- included_in (or i): The index templates that include this component template.
Values are name, n, version, v, alias_count, a, mapping_count, m, settings_count, s, metadata_count, me, included_in, or i.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

The period to wait for a connection to the master node.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- name string Required
- version string | null Required
  
  One of:
  string-1 string string-2 string | null
- alias_count string Required
- mapping_count string Required
- settings_count string Required
- metadata_count string Required
- included_in string Required

GET /_cat/component_templates/{name}

GET _cat/component_templates/my-template-*?v=true&s=name&format=json

resp = client.cat.component_templates(
    name="my-template-*",
    v=True,
    s="name",
    format="json",
)

const response = await client.cat.componentTemplates({
  name: "my-template-*",
  v: "true",
  s: "name",
  format: "json",
});

response = client.cat.component_templates(
  name: "my-template-*",
  v: "true",
  s: "name",
  format: "json"
)

$resp = $client->cat()->componentTemplates([
    "name" => "my-template-*",
    "v" => "true",
    "s" => "name",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/component_templates/my-template-*?v=true&s=name&format=json"

Response examples (200)

A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`.

[
  {
    "name": "my-template-1",
    "version": "null",
    "alias_count": "0",
    "mapping_count": "0",
    "settings_count": "1",
    "metadata_count": "0",
    "included_in": "[my-index-template]"
  },
    {
    "name": "my-template-2",
    "version": null,
    "alias_count": "0",
    "mapping_count": "3",
    "settings_count": "0",
    "metadata_count": "0",
    "included_in": "[my-index-template]"
  }
]

Get snapshot information Generally available; Added in 2.1.0

GET /_cat/snapshots/{repository}

Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_cat/snapshots

GET /_cat/snapshots/{repository}

Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.

Required authorization

Cluster privileges: monitor_snapshot

Path parameters

repository string | array[string] Required

A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, Elasticsearch returns an error.

Query parameters

ignore_unavailable boolean

If true, the response does not include information from unavailable snapshots.
h string | array[string]
A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:
- id (or snapshot): The ID of the snapshot, such as 'snap1'.
- repository (or re, repo): The name of the repository, such as 'repo1'.
- status (or s): State of the snapshot process. Returned values are: 'FAILED': The snapshot process failed. 'INCOMPATIBLE': The snapshot process is incompatible with the current cluster version. 'IN_PROGRESS': The snapshot process started but has not completed. 'PARTIAL': The snapshot process completed with a partial success. 'SUCCESS': The snapshot process completed with a full success.
- start_epoch (or ste, startEpoch): The unix epoch time at which the snapshot process started.
- start_time (or sti, startTime): 'HH:MM:SS' time at which the snapshot process started.
- end_epoch (or ete, endEpoch): The unix epoch time at which the snapshot process ended.
- end_time (or eti, endTime): 'HH:MM:SS' time at which the snapshot process ended.
- duration (or dur): The time it took the snapshot process to complete in time units.
- indices (or i): The number of indices in the snapshot.
- successful_shards (or ss): The number of successful shards in the snapshot.
- failed_shards (or fs): The number of failed shards in the snapshot.
- total_shards (or ts): The total number of shards in the snapshot.
- reason (or r): The reason for any snapshot failures.
Values are id, snapshot, repository, re, repo, status, s, start_epoch, ste, startEpoch, start_time, sti, startTime, end_epoch, ete, endEpoch, end_time, eti, endTime, duration, dur, indices, i, successful_shards, ss, failed_shards, fs, total_shards, ts, reason, or r.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
master_timeout string

Period to wait for a connection to the master node.

Values are -1 or 0.
time string

Unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the snapshot.
- repository string
  
  The repository name.
- status string
  
  The state of the snapshot process. Returned values include: FAILED: The snapshot process failed. INCOMPATIBLE: The snapshot process is incompatible with the current cluster version. IN_PROGRESS: The snapshot process started but has not completed. PARTIAL: The snapshot process completed with a partial success. SUCCESS: The snapshot process completed with a full success.
- start_epoch number | string
  
  The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.
  
  One of:
  UnitSeconds number string-2 string
  
  The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.
- start_time string | object
  
  The time (HH:MM:SS) at which the snapshot process started.
  
  One of:
  string-1 string HourAndMinute object
  
  The time (HH:MM:SS) at which the snapshot process started.
- end_epoch number | string
  
  The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.
  
  One of:
  UnitSeconds number string-2 string
  
  The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.
- end_time string
  
  The time (HH:MM:SS) at which the snapshot process ended.
- duration string
  
  The time it took the snapshot process to complete, in time units.
- indices string
  
  The number of indices in the snapshot.
- successful_shards string
  
  The number of successful shards in the snapshot.
- failed_shards string
  
  The number of failed shards in the snapshot.
- total_shards string
  
  The total number of shards in the snapshot.
- reason string
  
  The reason for any snapshot failures.

GET /_cat/snapshots/{repository}

GET /_cat/snapshots/repo1?v=true&s=id&format=json

resp = client.cat.snapshots(
    repository="repo1",
    v=True,
    s="id",
    format="json",
)

const response = await client.cat.snapshots({
  repository: "repo1",
  v: "true",
  s: "id",
  format: "json",
});

response = client.cat.snapshots(
  repository: "repo1",
  v: "true",
  s: "id",
  format: "json"
)

$resp = $client->cat()->snapshots([
    "repository" => "repo1",
    "v" => "true",
    "s" => "id",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/snapshots/repo1?v=true&s=id&format=json"

Response examples (200)

A successful response from `GET /_cat/snapshots/repo1?v=true&s=id&format=json`.

[
  {
    "id": "snap1",
    "repository": "repo1",
    "status": "FAILED",
    "start_epoch": "1445616705",
    "start_time": "18:11:45",
    "end_epoch": "1445616978",
    "end_time": "18:16:18",
    "duration": "4.6m",
    "indices": "1",
    "successful_shards": "4",
    "failed_shards": "1",
    "total_shards": "5"
  },
  {
    "id": "snap2",
    "repository": "repo1",
    "status": "SUCCESS",
    "start_epoch": "1445634298",
    "start_time": "23:04:58",
    "end_epoch": "1445634672",
    "end_time": "23:11:12",
    "duration": "6.2m",
    "indices": "2",
    "successful_shards": "10",
    "failed_shards": "0",
    "total_shards": "10"
  }
]

Get component templates Generally available; Added in 5.1.0

Required authorization

Path parameters

Query parameters

Responses

version string | null Required

Get snapshot information Generally available; Added in 2.1.0

Required authorization

Path parameters

Query parameters

Responses

start_epoch number | string

start_time string | object

end_epoch number | string