102 lines
4.7 KiB
Plaintext
102 lines
4.7 KiB
Plaintext
[[reference-xpack-usage]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
|
|| You should update the script that does the generation, which can be found in: ||
|
|
|| https://github.com/elastic/elastic-client-generator-js ||
|
|
|| ||
|
|
|| You can run the script with the following command: ||
|
|
|| npm run elasticsearch -- --version <version> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
|
|
[discrete]
|
|
[[client.xpack.usage]]
|
|
=== client.xpack.usage
|
|
|
|
This API provides information about which features are currently enabled and available under the current license and some usage statistics.
|
|
|
|
{ref}/usage-api.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(XpackUsageRequest, options?): Promise<XpackUsageResponse>
|
|
----
|
|
|
|
[discrete]
|
|
==== Request
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface XpackUsageRequest extends <<RequestBase>> {
|
|
master_timeout?: <<Duration>>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
[discrete]
|
|
==== Response
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface XpackUsageResponse {
|
|
aggregate_metric: XpackUsageBase
|
|
analytics: XpackUsageAnalytics
|
|
archive: XpackUsageArchive
|
|
watcher: XpackUsageWatcher
|
|
ccr: XpackUsageCcr
|
|
data_frame?: XpackUsageBase
|
|
data_science?: XpackUsageBase
|
|
data_streams?: XpackUsageDataStreams
|
|
data_tiers: XpackUsageDataTiers
|
|
enrich?: XpackUsageBase
|
|
eql: XpackUsageEql
|
|
flattened?: XpackUsageFlattened
|
|
frozen_indices: XpackUsageFrozenIndices
|
|
graph: XpackUsageBase
|
|
health_api?: XpackUsageHealthStatistics
|
|
ilm: XpackUsageIlm
|
|
logstash: XpackUsageBase
|
|
ml: XpackUsageMachineLearning
|
|
monitoring: XpackUsageMonitoring
|
|
rollup: XpackUsageBase
|
|
runtime_fields?: XpackUsageRuntimeFieldTypes
|
|
spatial: XpackUsageBase
|
|
searchable_snapshots: XpackUsageSearchableSnapshots
|
|
security: XpackUsageSecurity
|
|
slm: XpackUsageSlm
|
|
sql: XpackUsageSql
|
|
transform: XpackUsageBase
|
|
vectors?: XpackUsageVector
|
|
voting_only: XpackUsageBase
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|