- Elasticsearch Guide: other versions:
- What is Elasticsearch?
- What’s new in 7.10
- Getting started with Elasticsearch
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Setting JVM options
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Field data cache settings
- HTTP
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- License settings
- Local gateway settings
- Logging
- Machine learning settings
- Monitoring settings
- Node
- Network settings
- Node query cache settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot lifecycle management settings
- Transforms settings
- Transport
- Thread pools
- Watcher settings
- Important Elasticsearch configuration
- Important System Configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- G1GC check
- All permission check
- Discovery configuration check
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Set up X-Pack
- Configuring X-Pack Java Clients
- Plugins
- Upgrade Elasticsearch
- Index modules
- Mapping
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Index templates
- Data streams
- Ingest node
- Search your data
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Geo-distance
- Geohash grid
- Geotile grid
- Global
- Histogram
- IP range
- Missing
- Nested
- Parent
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Bucket aggregations
- EQL
- SQL access
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Overview
- Concepts
- Automate rollover
- Manage Filebeat time-based indices
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Resolve lifecycle policy execution errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Monitor a cluster
- Frozen indices
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure a cluster
- Overview
- Configuring security
- User authentication
- Built-in users
- Internal users
- Token-based authentication services
- Realms
- Realm chains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Granting access to Stack Management features
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and index aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enabling audit logging
- Encrypting communications
- Restricting connections with IP filtering
- Cross cluster search, clients, and integrations
- Tutorial: Getting started with security
- Tutorial: Encrypting communications
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Watch for cluster and index events
- Command line tools
- How To
- Glossary of terms
- REST APIs
- API conventions
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat segments
- cat shards
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Nodes reload secure settings
- Nodes stats
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Cross-cluster replication APIs
- Data stream APIs
- Document APIs
- Enrich APIs
- Graph explore API
- Index APIs
- Add index alias
- Analyze
- Clear cache
- Clone index
- Close index
- Create index
- Delete index
- Delete index alias
- Delete component template
- Delete index template
- Delete index template (legacy)
- Flush
- Force merge
- Freeze index
- Get component template
- Get field mapping
- Get index
- Get index alias
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Index alias exists
- Index exists
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- Open index
- Put index template
- Put index template (legacy)
- Put component template
- Put mapping
- Refresh
- Rollover index
- Shrink index
- Simulate index
- Simulate template
- Split index
- Synced flush
- Type exists
- Unfreeze index
- Update index alias
- Update index settings
- Resolve index
- List dangling indices
- Import dangling index
- Delete dangling index
- Index lifecycle management APIs
- Ingest APIs
- Info API
- Licensing APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- Find file structure
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get machine learning info
- Get model snapshots
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Revert model snapshots
- Set upgrade mode
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Create trained models
- Update data frame analytics jobs
- Delete data frame analytics jobs
- Delete trained models
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Get trained models
- Get trained models stats
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Migration APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Search APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete users
- Disable users
- Enable users
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get token
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SSL certificate
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Migration guide
- Release notes
- Elasticsearch version 7.10.2
- Elasticsearch version 7.10.1
- Elasticsearch version 7.10.0
- Elasticsearch version 7.9.3
- Elasticsearch version 7.9.2
- Elasticsearch version 7.9.1
- Elasticsearch version 7.9.0
- Elasticsearch version 7.8.1
- Elasticsearch version 7.8.0
- Elasticsearch version 7.7.1
- Elasticsearch version 7.7.0
- Elasticsearch version 7.6.2
- Elasticsearch version 7.6.1
- Elasticsearch version 7.6.0
- Elasticsearch version 7.5.2
- Elasticsearch version 7.5.1
- Elasticsearch version 7.5.0
- Elasticsearch version 7.4.2
- Elasticsearch version 7.4.1
- Elasticsearch version 7.4.0
- Elasticsearch version 7.3.2
- Elasticsearch version 7.3.1
- Elasticsearch version 7.3.0
- Elasticsearch version 7.2.1
- Elasticsearch version 7.2.0
- Elasticsearch version 7.1.1
- Elasticsearch version 7.1.0
- Elasticsearch version 7.0.0
- Elasticsearch version 7.0.0-rc2
- Elasticsearch version 7.0.0-rc1
- Elasticsearch version 7.0.0-beta1
- Elasticsearch version 7.0.0-alpha2
- Elasticsearch version 7.0.0-alpha1
- Dependencies and versions
cat anomaly detectors API
editcat anomaly detectors API
editReturns configuration and usage information about anomaly detection jobs.
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have
monitor_ml
,monitor
,manage_ml
, ormanage
cluster privileges to use this API. See Security privileges and Machine learning security privileges.
Path parameters
edit-
<job_id>
- (Optional, string) Identifier for the anomaly detection job.
Query parameters
edit-
allow_no_jobs
-
(Optional, Boolean)
[7.10]
Deprecated in 7.10. Use
allow_no_match
instead. -
allow_no_match
-
(Optional, Boolean) Specifies what to do when the request:
- Contains wildcard expressions and there are no jobs that match.
-
Contains the
_all
string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches.
The default value is
true
, which returns an emptyjobs
array when there are no matches and the subset of results when there are partial matches. If this parameter isfalse
, the request returns a404
status code when there are no matches or only partial matches. -
bytes
- (Optional, byte size units) Unit used to display byte values.
-
format
- (Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
-
h
-
(Optional, string) Comma-separated list of column names to display.
If you do not specify which columns to include, the API returns the default columns. If you explicitly specify one or more columns, it returns only the specified columns.
Valid columns are:
-
assignment_explanation
,ae
- For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.
-
buckets.count
,bc
,bucketsCount
- (Default) The number of bucket results produced by the job.
-
buckets.time.exp_avg
,btea
,bucketsTimeExpAvg
- Exponential moving average of all bucket processing times, in milliseconds.
-
buckets.time.exp_avg_hour
,bteah
,bucketsTimeExpAvgHour
- Exponentially-weighted moving average of bucket processing times calculated in a 1 hour time window, in milliseconds.
-
buckets.time.max
,btmax
,bucketsTimeMax
- Maximum among all bucket processing times, in milliseconds.
-
buckets.time.min
,btmin
,bucketsTimeMin
- Minimum among all bucket processing times, in milliseconds.
-
buckets.time.total
,btt
,bucketsTimeTotal
- Sum of all bucket processing times, in milliseconds.
-
data.buckets
,db
,dataBuckets
- The number of buckets processed.
-
data.earliest_record
,der
,dataEarliestRecord
- The timestamp of the earliest chronologically input document.
-
data.empty_buckets
,deb
,dataEmptyBuckets
-
The number of buckets which did not contain any data. If your data
contains many empty buckets, consider increasing your
bucket_span
or using functions that are tolerant to gaps in data such asmean
,non_null_sum
ornon_zero_count
. -
data.input_bytes
,dib
,dataInputBytes
- The number of bytes of input data posted to the anomaly detection job.
-
data.input_fields
,dif
,dataInputFields
- The total number of fields in input documents posted to the anomaly detection job. This count includes fields that are not used in the analysis. However, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job.
-
data.input_records
,dir
,dataInputRecords
- The number of input documents posted to the anomaly detection job.
-
data.invalid_dates
,did
,dataInvalidDates
- The number of input documents with either a missing date field or a date that could not be parsed.
-
data.last
,dl
,dataLast
- The timestamp at which data was last analyzed, according to server time.
-
data.last_empty_bucket
,dleb
,dataLastEmptyBucket
- The timestamp of the last bucket that did not contain any data.
-
data.last_sparse_bucket
,dlsb
,dataLastSparseBucket
- The timestamp of the last bucket that was considered sparse.
-
data.latest_record
,dlr
,dataLatestRecord
- The timestamp of the latest chronologically input document.
-
data.missing_fields
,dmf
,dataMissingFields
-
The number of input documents that are missing a field that the anomaly detection job is configured to analyze. Input documents with missing fields are still processed because it is possible that not all fields are missing.
If you are using datafeeds or posting data to the job in JSON format, a high
missing_field_count
is often not an indication of data issues. It is not necessarily a cause for concern. -
data.out_of_order_timestamps
,doot
,dataOutOfOrderTimestamps
- The number of input documents that are out of time sequence and outside of the latency window. This information is applicable only when you provide data to the anomaly detection job by using the post data API. These out of order documents are discarded, since jobs require time series data to be in ascending chronological order.
-
data.processed_fields
,dpf
,dataProcessedFields
- The total number of fields in all the documents that have been processed by the anomaly detection job. Only fields that are specified in the detector configuration object contribute to this count. The timestamp is not included in this count.
-
data.processed_records
,dpr
,dataProcessedRecords
-
(Default)
The number of input documents that have been processed by the anomaly detection job.
This value includes documents with missing fields, since they are nonetheless
analyzed. If you use datafeeds and have aggregations in your search query, the
processed_record_count
is the number of aggregation results processed, not the number of Elasticsearch documents. -
data.sparse_buckets
,dsb
,dataSparseBuckets
-
The number of buckets that contained few data points compared to the expected
number of data points. If your data contains many sparse buckets, consider using
a longer
bucket_span
. -
forecasts.memory.avg
,fmavg
,forecastsMemoryAvg
- The average memory usage in bytes for forecasts related to the anomaly detection job.
-
forecasts.memory.max
,fmmax
,forecastsMemoryMax
- The maximum memory usage in bytes for forecasts related to the anomaly detection job.
-
forecasts.memory.min
,fmmin
,forecastsMemoryMin
- The minimum memory usage in bytes for forecasts related to the anomaly detection job.
-
forecasts.memory.total
,fmt
,forecastsMemoryTotal
- The total memory usage in bytes for forecasts related to the anomaly detection job.
-
forecasts.records.avg
,fravg
,forecastsRecordsAvg
-
The average number of
model_forecast
documents written for forecasts related to the anomaly detection job. -
forecasts.records.max
,frmax
,forecastsRecordsMax
-
The maximum number of
model_forecast
documents written for forecasts related to the anomaly detection job. -
forecasts.records.min
,frmin
,forecastsRecordsMin
-
The minimum number of
model_forecast
documents written for forecasts related to the anomaly detection job. -
forecasts.records.total
,frt
,forecastsRecordsTotal
-
The total number of
model_forecast
documents written for forecasts related to the anomaly detection job. -
forecasts.time.avg
,ftavg
,forecastsTimeAvg
- The average runtime in milliseconds for forecasts related to the anomaly detection job.
-
forecasts.time.max
,ftmax
,forecastsTimeMax
- The maximum runtime in milliseconds for forecasts related to the anomaly detection job.
-
forecasts.time.min
,ftmin
,forecastsTimeMin
- The minimum runtime in milliseconds for forecasts related to the anomaly detection job.
-
forecasts.time.total
,ftt
,forecastsTimeTotal
- The total runtime in milliseconds for forecasts related to the anomaly detection job.
-
forecasts.total
,ft
,forecastsTotal
-
(Default)
The number of individual forecasts currently available for the job. A value of
1
or more indicates that forecasts exist. -
id
- (Default) Identifier for the anomaly detection job.
-
model.bucket_allocation_failures
,mbaf
,modelBucketAllocationFailures
-
The number of buckets for which new entities in incoming data were not processed
due to insufficient model memory. This situation is also signified by a
hard_limit: memory_status
property value. -
model.by_fields
,mbf
,modelByFields
-
The number of
by
field values that were analyzed by the models. This value is cumulative for all detectors in the job. -
model.bytes
,mb
,modelBytes
- (Default) The number of bytes of memory used by the models. This is the maximum value since the last time the model was persisted. If the job is closed, this value indicates the latest size.
-
model.bytes_exceeded
,mbe
,modelBytesExceeded
- The number of bytes over the high limit for memory usage at the last allocation failure.
-
model.categorization_status
,mcs
,modelCategorizationStatus
-
The status of categorization for the job. Contains one of the following values:
-
ok
: Categorization is performing acceptably well (or not being used at all). -
warn
: Categorization is detecting a distribution of categories that suggests the input data is inappropriate for categorization. Problems could be that there is only one category, more than 90% of categories are rare, the number of categories is greater than 50% of the number of categorized documents, there are no frequently matched categories, or more than 50% of categories are dead.
-
-
model.categorized_doc_count
,mcdc
,modelCategorizedDocCount
- The number of documents that have had a field categorized.
-
model.dead_category_count
,mdcc
,modelDeadCategoryCount
- The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category. (Dead categories are a side effect of the way categorization has no prior training.)
-
model.failed_category_count
,mdcc
,modelFailedCategoryCount
-
The number of times that categorization wanted to create a new category but
couldn’t because the job had hit its
model_memory_limit
. This count does not track which specific categories failed to be created. Therefore you cannot use this value to determine the number of unique categories that were missed. -
model.frequent_category_count
,mfcc
,modelFrequentCategoryCount
- The number of categories that match more than 1% of categorized documents.
-
model.log_time
,mlt
,modelLogTime
- The timestamp when the model stats were gathered, according to server time.
-
model.memory_limit
,mml
,modelMemoryLimit
- The upper limit for model memory usage, checked on increasing values.
-
model.memory_status
,mms
,modelMemoryStatus
-
(Default) The status of the mathematical models, which can have one of the following values:
-
ok
: The models stayed below the configured value. -
soft_limit
: The models used more than 60% of the configured memory limit and older unused models will be pruned to free up space. Additionally, in categorization jobs no further category examples will be stored. -
hard_limit
: The models used more space than the configured memory limit. As a result, not all incoming data was processed.
-
-
model.over_fields
,mof
,modelOverFields
-
The number of
over
field values that were analyzed by the models. This value is cumulative for all detectors in the job. -
model.partition_fields
,mpf
,modelPartitionFields
-
The number of
partition
field values that were analyzed by the models. This value is cumulative for all detectors in the job. -
model.rare_category_count
,mrcc
,modelRareCategoryCount
- The number of categories that match just one categorized document.
-
model.timestamp
,mt
,modelTimestamp
- The timestamp of the last record when the model stats were gathered.
-
model.total_category_count
,mtcc
,modelTotalCategoryCount
- The number of categories created by categorization.
-
node.address
,na
,nodeAddress
-
The network address of the node.
Contains properties for the node that runs the job. This information is available only for open jobs.
-
node.ephemeral_id
,ne
,nodeEphemeralId
-
The ephemeral ID of the node.
Contains properties for the node that runs the job. This information is available only for open jobs.
-
node.id
,ni
,nodeId
-
The unique identifier of the node.
Contains properties for the node that runs the job. This information is available only for open jobs.
-
node.name
,nn
,nodeName
-
The node name.
Contains properties for the node that runs the job. This information is available only for open jobs.
-
opened_time
,ot
- For open jobs only, the elapsed time for which the job has been open.
-
state
,s
-
(Default) The status of the anomaly detection job, which can be one of the following values:
-
closed
: The job finished successfully with its model state persisted. The job must be opened before it can accept further data. -
closing
: The job close action is in progress and has not yet completed. A closing job cannot accept further data. -
failed
: The job did not finish successfully due to an error. This situation can occur due to invalid input data, a fatal error occurring during the analysis, or an external interaction such as the process being killed by the Linux out of memory (OOM) killer. If the job had irrevocably failed, it must be force closed and then deleted. If the datafeed can be corrected, the job can be closed and then re-opened. -
opened
: The job is available to receive and process data. -
opening
: The job open action is in progress and has not yet completed.
-
-
-
help
-
(Optional, Boolean) If
true
, the response includes help information. Defaults tofalse
. -
s
- (Optional, string) Comma-separated list of column names or column aliases used to sort the response.
-
time
- (Optional, time units) Unit used to display time values.
-
v
-
(Optional, Boolean) If
true
, the response includes column headings. Defaults tofalse
.
Examples
editGET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true
id s dpr mb high_sum_total_sales closed 14022 1.5mb low_request_rate closed 1216 40.5kb response_code_rates closed 28146 132.7kb url_scanning closed 28146 501.6kb