plugins.asciidoc 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. [[cat-plugins]]
  2. === cat plugins API
  3. ++++
  4. <titleabbrev>cat plugins</titleabbrev>
  5. ++++
  6. Returns a list of plugins running on each node of a cluster.
  7. [[cat-plugins-api-request]]
  8. ==== {api-request-title}
  9. `GET /_cat/plugins`
  10. [[cat-plugins-api-prereqs]]
  11. ==== {api-prereq-title}
  12. * If the {es} {security-features} are enabled, you must have the `monitor` or
  13. `manage` <<privileges-list-cluster,cluster privilege>> to use this API.
  14. [[cat-plugins-api-query-params]]
  15. ==== {api-query-parms-title}
  16. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
  17. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
  18. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
  19. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
  20. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
  21. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
  22. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
  23. [[cat-plugins-api-example]]
  24. ==== {api-examples-title}
  25. [source,console]
  26. ------------------------------------------------------------------------------
  27. GET /_cat/plugins?v=true&s=component&h=name,component,version,description
  28. ------------------------------------------------------------------------------
  29. The API returns the following response:
  30. ["source","txt",subs="attributes,callouts"]
  31. ------------------------------------------------------------------------------
  32. name component version description
  33. U7321H6 analysis-icu {version_qualified} The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components.
  34. U7321H6 analysis-kuromoji {version_qualified} The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch.
  35. U7321H6 analysis-nori {version_qualified} The Korean (nori) Analysis plugin integrates Lucene nori analysis module into elasticsearch.
  36. U7321H6 analysis-phonetic {version_qualified} The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch.
  37. U7321H6 analysis-smartcn {version_qualified} Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch.
  38. U7321H6 analysis-stempel {version_qualified} The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch.
  39. U7321H6 analysis-ukrainian {version_qualified} The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch.
  40. U7321H6 discovery-azure-classic {version_qualified} The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism
  41. U7321H6 discovery-ec2 {version_qualified} The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism.
  42. U7321H6 discovery-gce {version_qualified} The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism.
  43. U7321H6 ingest-attachment {version_qualified} Ingest processor that uses Apache Tika to extract contents
  44. U7321H6 mapper-annotated-text {version_qualified} The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index.
  45. U7321H6 mapper-murmur3 {version_qualified} The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index.
  46. U7321H6 mapper-size {version_qualified} The Mapper Size plugin allows document to record their uncompressed size at index time.
  47. U7321H6 store-smb {version_qualified} The Store SMB plugin adds support for SMB stores.
  48. U7321H6 transport-nio {version_qualified} The nio transport.
  49. ------------------------------------------------------------------------------
  50. // TESTRESPONSE[s/([.()])/\\$1/ s/U7321H6/.+/ non_json]