[DOCS] Updated links to the ES Ref for the X-Pack ref.
Original commit: elastic/x-pack-elasticsearch@d47f276678
This commit is contained in:
Deb Adair
parent
32a283c51d
commit
3b87e67ec4
|
|
@ -3,116 +3,16 @@
|
||||||
|
|
||||||
[partintro]
|
[partintro]
|
||||||
--
|
--
|
||||||
{xpack} exposes a wide range of REST APIs to manage and monitor its features.
|
{xpack} exposes REST APIs that are used by the UI components and can be called
|
||||||
|
directly to configure and access {xpack} features.
|
||||||
|
|
||||||
* <<info-api, Info API>>
|
* {ref}/info-api[Info API]
|
||||||
|
* {ref}/graph-explore-api[Graph APIs]
|
||||||
* <<security-api, Security APIs>>
|
* <<security-api, Security APIs>>
|
||||||
* {ref}/watcher-api.html[Watcher APIs]
|
|
||||||
* <<graph-api, Graph APIs>>
|
|
||||||
* {ref}/ml-apis.html[Machine Learning APIs]
|
* {ref}/ml-apis.html[Machine Learning APIs]
|
||||||
* {ref}/ml-api-definitions.html[Definitions]
|
* {ref}/ml-api-definitions.html[Definitions]
|
||||||
|
* {ref}/watcher-api.html[Watcher APIs]
|
||||||
|
|
||||||
--
|
--
|
||||||
|
|
||||||
[[info-api]]
|
|
||||||
== Info API
|
|
||||||
|
|
||||||
The info API provides general information on the installed {xpack}. This
|
|
||||||
information includes:
|
|
||||||
|
|
||||||
* Build Information - including the build number and timestamp.
|
|
||||||
* License Information - basic information about the currently installed license.
|
|
||||||
* Features Information - The features that are currently enabled and available
|
|
||||||
under the current license.
|
|
||||||
|
|
||||||
The following example queries the info API:
|
|
||||||
|
|
||||||
[source,js]
|
|
||||||
------------------------------------------------------------
|
|
||||||
GET /_xpack
|
|
||||||
------------------------------------------------------------
|
|
||||||
// CONSOLE
|
|
||||||
|
|
||||||
Example response:
|
|
||||||
[source,js]
|
|
||||||
------------------------------------------------------------
|
|
||||||
{
|
|
||||||
"build" : {
|
|
||||||
"hash" : "2798b1a3ce779b3611bb53a0082d4d741e4d3168",
|
|
||||||
"date" : "2015-04-07T13:34:42Z"
|
|
||||||
},
|
|
||||||
"license" : {
|
|
||||||
"uid" : "893361dc-9749-4997-93cb-802e3dofh7aa",
|
|
||||||
"type" : "trial",
|
|
||||||
"mode" : "trial",
|
|
||||||
"status" : "active",
|
|
||||||
"expiry_date_in_millis" : 1914278399999
|
|
||||||
},
|
|
||||||
"features" : {
|
|
||||||
"graph" : {
|
|
||||||
"description" : "Graph Data Exploration for the Elastic Stack",
|
|
||||||
"available" : true,
|
|
||||||
"enabled" : true
|
|
||||||
},
|
|
||||||
"logstash" : {
|
|
||||||
"description" : "Logstash management component for X-Pack",
|
|
||||||
"available" : true,
|
|
||||||
"enabled" : true
|
|
||||||
},
|
|
||||||
"ml" : {
|
|
||||||
"description" : "Machine Learning for the Elastic Stack",
|
|
||||||
"available" : true,
|
|
||||||
"enabled" : true,
|
|
||||||
"native_code_info" : {
|
|
||||||
"version" : "6.0.0-alpha1-SNAPSHOT",
|
|
||||||
"build_hash" : "d081461967d61a"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"monitoring" : {
|
|
||||||
"description" : "Monitoring for the Elastic Stack",
|
|
||||||
"available" : true,
|
|
||||||
"enabled" : true
|
|
||||||
},
|
|
||||||
"security" : {
|
|
||||||
"description" : "Security for the Elastic Stack",
|
|
||||||
"available" : true,
|
|
||||||
"enabled" : true
|
|
||||||
},
|
|
||||||
"watcher" : {
|
|
||||||
"description" : "Alerting, Notification and Automation for the Elastic Stack",
|
|
||||||
"available" : true,
|
|
||||||
"enabled" : true
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"tagline" : "You know, for X"
|
|
||||||
}
|
|
||||||
------------------------------------------------------------
|
|
||||||
// TESTRESPONSE[s/"hash" : "2798b1a3ce779b3611bb53a0082d4d741e4d3168",/"hash" : "$body.build.hash",/]
|
|
||||||
// TESTRESPONSE[s/"date" : "2015-04-07T13:34:42Z"/"date" : "$body.build.date"/]
|
|
||||||
// TESTRESPONSE[s/"uid" : "893361dc-9749-4997-93cb-802e3dofh7aa",/"uid": "$body.license.uid",/]
|
|
||||||
// TESTRESPONSE[s/"expiry_date_in_millis" : 1914278399999/"expiry_date_in_millis" : "$body.license.expiry_date_in_millis"/]
|
|
||||||
// TESTRESPONSE[s/"version" : "6.0.0-alpha1-SNAPSHOT",/"version": "$body.features.ml.native_code_info.version",/]
|
|
||||||
// TESTRESPONSE[s/"build_hash" : "d081461967d61a"/"build_hash": "$body.features.ml.native_code_info.build_hash"/]
|
|
||||||
// So much s/// but at least we test that the layout is close to matching....
|
|
||||||
|
|
||||||
You can also control what information is returned using the `categories` and
|
|
||||||
`human` parameters.
|
|
||||||
|
|
||||||
The following example only returns the build and features information:
|
|
||||||
|
|
||||||
[source,js]
|
|
||||||
------------------------------------------------------------
|
|
||||||
GET /_xpack?categories=build,features
|
|
||||||
------------------------------------------------------------
|
|
||||||
// CONSOLE
|
|
||||||
|
|
||||||
The following example removes the descriptions from the response:
|
|
||||||
|
|
||||||
[source,js]
|
|
||||||
------------------------------------------------------------
|
|
||||||
GET /_xpack?human=false
|
|
||||||
------------------------------------------------------------
|
|
||||||
// CONSOLE
|
|
||||||
|
|
||||||
include::security.asciidoc[]
|
include::security.asciidoc[]
|
||||||
|
|
||||||
include::graph.asciidoc[]
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue