mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 09:28:55 -04:00
ac36aa7795
To improve cross-cluster search user experience, Kibana needs an endpoint that is accessible
by arbitrary Kibana dashboard search users and provides:
1. a listing of clusters in scope for a CCS query (based on the index expression and whether
there are any indices on each cluster that the Kibana user has access to query).
2. whether that cluster is currently connected to the querying cluster (will it come back as
skipped or failed in a CCS search)
3. showing the skip_unavailable setting for those clusters (so you can know whether it will
return skipped or failed in a CCS search)
4. the ES version of the cluster
Since no single Elasticsearch endpoint provides all of these features, this PR creates a new endpoint `_resolve/cluster` that works along side the existing `_resolve/index` endpoint
(and leverages some of its features).
Example usage against a cluster with 2 remote clusters configured:
GET /_resolve/cluster/*,remote*:bl*
Response:
{
"(local)": {
"connected": true,
"skip_unavailable": false,
"matching_indices": true,
"version": {
"number": "8.12.0-SNAPSHOT",
"build_flavor": "default",
"minimum_wire_compatibility_version": "7.17.0",
"minimum_index_compatibility_version": "7.0.0"
}
},
"remote2": {
"connected": true,
"skip_unavailable": true,
"matching_indices": true,
"version": {
"number": "8.12.0-SNAPSHOT",
"build_flavor": "default",
"minimum_wire_compatibility_version": "7.17.0",
"minimum_index_compatibility_version": "7.0.0"
}
},
"remote1": {
"connected": true,
"skip_unavailable": false,
"matching_indices": false,
"version": {
"number": "8.12.0-SNAPSHOT",
"build_flavor": "default",
"minimum_wire_compatibility_version": "7.17.0",
"minimum_index_compatibility_version": "7.0.0"
}
}
}
Almost all errors show up as "error" entries in the response.
Only the local SecurityException returns a 403 since that happens before the ResolveCluster
Transport code kicks in.
142 lines
4.2 KiB
Text
142 lines
4.2 KiB
Text
[[indices]]
|
|
== Index APIs
|
|
|
|
Index APIs are used to manage individual indices,
|
|
index settings, aliases, mappings, and index templates.
|
|
|
|
[discrete]
|
|
[[index-management]]
|
|
=== Index management:
|
|
|
|
* <<indices-create-index>>
|
|
* <<indices-delete-index>>
|
|
* <<indices-get-index>>
|
|
* <<indices-exists>>
|
|
* <<indices-close>>
|
|
* <<indices-open-close>>
|
|
* <<indices-shrink-index>>
|
|
* <<indices-split-index>>
|
|
* <<indices-clone-index>>
|
|
* <<indices-rollover-index>>
|
|
* <<unfreeze-index-api>>
|
|
* <<indices-resolve-index-api>>
|
|
* <<indices-resolve-cluster-api>>
|
|
* <<indices-downsample-data-stream>>
|
|
|
|
[discrete]
|
|
[[mapping-management]]
|
|
=== Mapping management:
|
|
|
|
* <<indices-put-mapping>>
|
|
* <<indices-get-mapping>>
|
|
* <<indices-get-field-mapping>>
|
|
* <<indices-disk-usage>>
|
|
|
|
[discrete]
|
|
[[alias-management]]
|
|
=== Alias management:
|
|
* <<indices-aliases>>
|
|
* <<indices-add-alias>>
|
|
* <<indices-get-alias>>
|
|
* <<indices-alias-exists>>
|
|
* <<indices-delete-alias>>
|
|
|
|
[discrete]
|
|
[[index-settings]]
|
|
=== Index settings:
|
|
* <<indices-update-settings>>
|
|
* <<indices-get-settings>>
|
|
* <<indices-analyze>>
|
|
|
|
[discrete]
|
|
[[index-templates-apis]]
|
|
=== Index templates:
|
|
|
|
Index templates automatically apply settings, mappings, and aliases to new indices.
|
|
They are most often used to configure rolling indices for time series data to
|
|
ensure that each new index has the same configuration as the previous one.
|
|
The index template associated with a data stream configures its backing indices.
|
|
For more information, see <<index-templates, Index Templates>>.
|
|
|
|
* <<indices-put-template>>
|
|
* <<indices-get-template>>
|
|
* <<indices-delete-template>>
|
|
* <<indices-component-template>>
|
|
* <<getting-component-templates>>
|
|
* <<indices-delete-component-template>>
|
|
* <<indices-simulate-index>>
|
|
* <<indices-simulate-template>>
|
|
|
|
[discrete]
|
|
[[monitoring]]
|
|
=== Monitoring:
|
|
* <<indices-stats>>
|
|
* <<field-usage-stats>>
|
|
* <<indices-segments>>
|
|
* <<indices-recovery>>
|
|
* <<indices-shards-stores>>
|
|
|
|
[discrete]
|
|
[[status-management]]
|
|
=== Status management:
|
|
* <<indices-clearcache>>
|
|
* <<indices-refresh>>
|
|
* <<indices-flush>>
|
|
* <<indices-forcemerge>>
|
|
|
|
[discrete]
|
|
[[dangling-indices-api]]
|
|
=== Dangling indices:
|
|
* <<dangling-indices-list>>
|
|
* <<dangling-index-import>>
|
|
* <<dangling-index-delete>>
|
|
|
|
include::indices/alias-exists.asciidoc[]
|
|
include::indices/aliases.asciidoc[]
|
|
include::indices/analyze.asciidoc[]
|
|
include::indices/diskusage.asciidoc[]
|
|
include::indices/clearcache.asciidoc[]
|
|
include::indices/clone-index.asciidoc[]
|
|
include::indices/close.asciidoc[]
|
|
include::indices/create-index.asciidoc[]
|
|
include::indices/add-alias.asciidoc[]
|
|
include::indices/put-component-template.asciidoc[]
|
|
include::indices/put-index-template.asciidoc[]
|
|
include::indices/put-index-template-v1.asciidoc[]
|
|
include::indices/delete-component-template.asciidoc[]
|
|
include::indices/dangling-index-delete.asciidoc[]
|
|
include::indices/delete-alias.asciidoc[]
|
|
include::indices/delete-index.asciidoc[]
|
|
include::indices/delete-index-template.asciidoc[]
|
|
include::indices/delete-index-template-v1.asciidoc[]
|
|
include::indices/indices-exists.asciidoc[]
|
|
include::indices/field-usage-stats.asciidoc[]
|
|
include::indices/flush.asciidoc[]
|
|
include::indices/forcemerge.asciidoc[]
|
|
include::indices/get-alias.asciidoc[]
|
|
include::indices/get-component-template.asciidoc[]
|
|
include::indices/get-field-mapping.asciidoc[]
|
|
include::indices/get-index.asciidoc[]
|
|
include::indices/get-settings.asciidoc[]
|
|
include::indices/get-index-template.asciidoc[]
|
|
include::indices/get-index-template-v1.asciidoc[]
|
|
include::indices/get-mapping.asciidoc[]
|
|
include::indices/dangling-index-import.asciidoc[]
|
|
include::indices/recovery.asciidoc[]
|
|
include::indices/segments.asciidoc[]
|
|
include::indices/shard-stores.asciidoc[]
|
|
include::indices/stats.asciidoc[]
|
|
include::indices/index-template-exists-v1.asciidoc[]
|
|
include::indices/dangling-indices-list.asciidoc[]
|
|
include::indices/open-close.asciidoc[]
|
|
include::indices/refresh.asciidoc[]
|
|
include::indices/resolve.asciidoc[]
|
|
include::indices/resolve-cluster.asciidoc[]
|
|
include::indices/rollover-index.asciidoc[]
|
|
include::indices/shrink-index.asciidoc[]
|
|
include::indices/simulate-index.asciidoc[]
|
|
include::indices/simulate-template.asciidoc[]
|
|
include::indices/split-index.asciidoc[]
|
|
include::indices/apis/unfreeze.asciidoc[]
|
|
include::indices/update-settings.asciidoc[]
|
|
include::indices/put-mapping.asciidoc[]
|