少々思うことがあり、Elasticsearchの公式JavaScriptクライアントで何ができるのか俯瞰したかったため、APIのパラメータ早見表としてまとめてみました。
見る限り、Elasticsearchの提供するすべてのAPIインタフェースに対応するものがあるようです。
www.elastic.co
6.5 API | elasticsearch.js | Elastic
バージョン6.5のドキュメントからまとめました。
(まとめていて思ったのですが、Elasticsearchが「機能的」に何ができるかを俯瞰するとした場合に、自分の得意な言語の公式クライアントのAPI一覧から入るのは、勉強の仕方としてはアリだなと思いました。)
念のための言い訳なのですが、正確なところは公式ドキュメントを適宜参照いただく前提です。
このAPIとこのAPIでできることの違いはなんだっけ...というようなところをパラメータの違いから目grepで一瞥できるようなことを目指しています。
(自分が使うつもりの気持ちで編集しましたが、逆にいうと間違っている可能性がありますのでご了承ください。)
画像版
...むむ、画像サイズが思うようにいかないかも。
pdf版
github.com
client.termvectors( { body : {}, termStatistics :true, routing :"String", parent :"String", preference :"String", fields :"String_String[]_Boolean", [offsets=true] :true, [positions=true] :true, [payloads=true] :true, version : 99999, versionType :"String", realtime :true});
client.mtermvectors( { body : {}, typedKeys :true, [fieldStatistics=true] :true, termStatistics :true, id :"String", index :"String", type :"String", routing :"String", parent :"String", preference :"String", ids :"String_String[]_Boolean", fields :"String_String[]_Boolean", [offsets=true] :true, [positions=true] :true, [payloads=true] :true, version : 99999, versionType :"String", realtime :true});
client.bulk( { body : "JSONLines", pipeline :"String", waitForActiveShards :"String", index :"String", type :"String", routing :"String", fields :"String_String[]_Boolean", _source :"String_String[]_Boolean", _sourceExclude :"String_String[]_Boolean", _sourceInclude :"String_String[]_Boolean", timeout :"2019-01-01", refresh :"String"});
client.index( { body : {}, pipeline :"String", [opType=index] :"String", waitForActiveShards :"String", index :"String", type :"String", routing :"String", parent :"String", version : 99999, versionType :"String", timeout :"2019-01-01", refresh :"String"});
client.create( { body : {}, pipeline :"String", waitForActiveShards :"String", id :"String", index :"String", type :"String", routing :"String", parent :"String", version : 99999, versionType :"String", timeout :"2019-01-01", refresh :"String"});
client.update( { body : {}, lang :"String", retryOnConflict : 99999, waitForActiveShards :"String", id :"String", index :"String", type :"String", routing :"String", parent :"String", _source :"String_String[]_Boolean", _sourceExclude :"String_String[]_Boolean", _sourceInclude :"String_String[]_Boolean", version : 99999, versionType :"String", timeout :"2019-01-01", refresh :"String"});
client.delete( { body : {}, waitForActiveShards :"String", id :"String", index :"String", type :"String", routing :"String", parent :"String", version : 99999, versionType :"String", timeout :"2019-01-01", refresh :"String"});
client.exists( { body : {}, id :"String", index :"String", type :"String", routing :"String", parent :"String", preference :"String", _source :"String_String[]_Boolean", _sourceExclude :"String_String[]_Boolean", _sourceInclude :"String_String[]_Boolean", storedFields :"String_String[]_Boolean", version : 99999, versionType :"String", realtime :true, refresh :true });
client.get( { id :"String", index :"String", type :"String", routing :"String", parent :"String", preference :"String", _source :"String_String[]_Boolean", _sourceExclude :"String_String[]_Boolean", _sourceInclude :"String_String[]_Boolean", storedFields :"String_String[]_Boolean", version : 99999, versionType :"String", realtime :true, refresh :true });
client.mget( { body : {}, id :"String", index :"String", type :"String", routing :"String", _source :"String_String[]_Boolean", _sourceExclude :"String_String[]_Boolean", _sourceInclude :"String_String[]_Boolean", storedFields :"String_String[]_Boolean", realtime :true, refresh :true });
client.existsSource( { body : {}, index :"String", type :"String", routing :"String", parent :"String", preference :"String", _source :"String_String[]_Boolean", _sourceExclude :"String_String[]_Boolean", _sourceInclude :"String_String[]_Boolean", version : 99999, versionType :"String", realtime :true, refresh :true });
client.getSource( { id :"String", index :"String", type :"String", routing :"String", parent :"String", preference :"String", _source :"String_String[]_Boolean", _sourceExclude :"String_String[]_Boolean", _sourceInclude :"String_String[]_Boolean", version : 99999, versionType :"String", realtime :true, refresh :true });
client.explain( { body : {}, q :"String", [defaultOperator=OR] :"String", df :"String", id :"String", index :"String", type :"String", routing :"String", parent :"String", preference :"String", _source :"String_String[]_Boolean", _sourceExclude :"String_String[]_Boolean", _sourceInclude :"String_String[]_Boolean", storedFields :"String_String[]_Boolean", analyzeWildcard :true, analyzer :"String"});
client.search( { body : {}, typedKeys :true, explain :true, q :"String", [defaultOperator=OR] :"String", df :"String", [maxConcurrentShardRequests=The default grows with the number of nodes in the cluster but is at most 256.] : 99999, id :"String", index :"String_String[]_Boolean", type :"String_String[]_Boolean", routing :"String_String[]_Boolean", preference :"String", [expandWildcards=open] :"String", _source :"String_String[]_Boolean", _sourceExclude :"String_String[]_Boolean", _sourceInclude :"String_String[]_Boolean", storedFields :"String_String[]_Boolean", version :true, timeout :"2019-01-01", analyzeWildcard :true, analyzer :"String", ignoreUnavailable :true, allowNoIndices :true, terminateAfter : 99999, lenient :true, size : 99999, from : 99999, stats :"String_String[]_Boolean", requestCache :true, sort :"String_String[]_Boolean", scroll :"2019-01-01", trackScores :true, trackTotalHits :true, [batchedReduceSize=512] : 99999, [preFilterShardSize=128] : 99999, [allowPartialSearchResults=true] :true, suggestField :"String", [suggestMode=missing] :"String", suggestSize : 99999, suggestText :"String", searchType :"String", docvalueFields :"String_String[]_Boolean"});
client. count( { body : {}, minScore : 99999, q :"String", [defaultOperator=OR] :"String", df :"String", index :"String_String[]_Boolean", type :"String_String[]_Boolean", routing :"String_String[]_Boolean", preference :"String", [expandWildcards=open] :"String", fields :"String_String[]_Boolean", analyzeWildcard :true, analyzer :"String", ignoreUnavailable :true, allowNoIndices :true, terminateAfter : 99999, lenient :true});
client.updateByQuery( { body : {}, pipeline :"String", requestsPerSecond : 99999, q :"String", [defaultOperator=OR] :"String", df :"String", waitForActiveShards :"String", [waitForCompletion=true] :true, index :"String_String[]_Boolean", type :"String_String[]_Boolean", routing :"String_String[]_Boolean", searchType :"String", preference :"String", [expandWildcards=open] :"String", _source :"String_String[]_Boolean", _sourceInclude :"String_String[]_Boolean", version :true, versionType :true, [timeout=1m] :"2019-01-01", refresh :true, analyzeWildcard :true, analyzer :"String", ignoreUnavailable :true, allowNoIndices :true, terminateAfter : 99999, lenient :true, size : 99999, from : 99999, stats :"String_String[]_Boolean", requestCache :true, sort :"String_String[]_Boolean", scroll :"2019-01-01", searchTimeout :"2019-01-01", scrollSize : 99999, [slices=1] : 99999, [conflicts=abort] :"String"});
client.deleteByQuery( { body : {}, requestsPerSecond : 99999, q :"String", [defaultOperator=OR] :"String", df :"String", waitForActiveShards :"String", [waitForCompletion=true] :true, index :"String_String[]_Boolean", type :"String_String[]_Boolean", routing :"String_String[]_Boolean", searchType :"String", preference :"String", [expandWildcards=open] :"String", _source :"String_String[]_Boolean", _sourceExclude :"String_String[]_Boolean", _sourceInclude :"String_String[]_Boolean", version :true, [timeout=1m] :"2019-01-01", refresh :true, analyzeWildcard :true, analyzer :"String", ignoreUnavailable :true, allowNoIndices :true, terminateAfter : 99999, lenient :true, size : 99999, from : 99999, stats :"String_String[]_Boolean", requestCache :true, sort :"String_String[]_Boolean", scroll :"2019-01-01", searchTimeout :"2019-01-01", scrollSize : 99999, [slices=1] : 99999, [conflicts=abort] :"String"});
client.updateByQueryRethrottle( { body : {}, _sourceExclude :"String_String[]_Boolean"});
client.deleteByQueryRethrottle( { body : {}, taskId :"String", requestsPerSecond : 99999});
client.msearch( { body : "JSONLines", typedKeys :true, [preFilterShardSize=128] : 99999, [maxConcurrentShardRequests=The default grows with the number of nodes in the cluster but is at most 256.] : 99999, index :"String_String[]_Boolean", type :"String_String[]_Boolean", searchType :"String", preference :"String"});
client.scroll( { body : {}, scrollId :"String", scroll :"2019-01-01"});
client.clearScroll( { body : {}, scrollId :"String_String[]_Boolean"});
client.reindex( { body : {}, [slices=1] : 99999, requestsPerSecond : 99999, waitForActiveShards :"String", [waitForCompletion=true] :true, refresh :true, allowNoIndices :true });
client.reindexRethrottle( { body : {}, taskId :"String", requestsPerSecond : 99999, [timeout=1m] :"2019-01-01"});
client.scriptsPainlessExecute( { body : {}});
client.searchShards( { body : {}, index :"String_String[]_Boolean", local :true, preference :"String", [expandWildcards=open] :"String", _source :"String_String[]_Boolean", ignoreUnavailable :true, allowNoIndices :true });
client.getScript( { id :"String", masterTimeout :"2019-01-01"});
client.putScript( { body : {}, context :"String", id :"String", timeout :"2019-01-01"});
client.deleteScript( { body : {}, id :"String", masterTimeout :"2019-01-01", timeout :"2019-01-01"});
client.rankEval( { body : {}, index :"String_String[]_Boolean", routing :"String", [expandWildcards=open] :"String", masterTimeout :"2019-01-01", ignoreUnavailable :true});
client.searchTemplate( { body : {}, typedKeys :true, explain :true, index :"String_String[]_Boolean", type :"String_String[]_Boolean", routing :"String_String[]_Boolean", searchType :"String", preference :"String", [expandWildcards=open] :"String", profile :true, scroll :"2019-01-01", ignoreUnavailable :true});
client.msearchTemplate( { body : "JSONLines", index :"String_String[]_Boolean", type :"String_String[]_Boolean", searchType :"String", maxConcurrentSearches : 99999});
client.renderSearchTemplate( { id :"String"});
client.ping( "省略");
client.info( ”省略");
client.fieldCaps( { body : {}, index :"String_String[]_Boolean", [expandWildcards=open] :"String", fields :"String_String[]_Boolean", ignoreUnavailable :true, allowNoIndices :true });
client.cat.help( { local :true, help :true, [ts=true] :true});
client.cat.aliases( { format :"String", masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, name :"String_String[]_Boolean"});
client.cat.allocation( { format :"String", local :true, masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, nodeId :"String_String[]_Boolean"});
client.cat.count( { format :"String", bytes :"String", masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, index :"String_String[]_Boolean"});
client.cat.fielddata( { format :"String", local :true, masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, fields :"String_String[]_Boolean"});
client.cat.health( { format :"String", bytes :"String", masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true});
client.cat.indices( { format :"String", local :true, masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, index :"String_String[]_Boolean", health :"String", pri :true });
client.cat.master( { format :"String", bytes :"String", masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true});
client.cat.nodeattrs( { format :"String", local :true, masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true});
client.cat.nodes( { format :"String", local :true, masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true});
client.cat.pendingTasks( { format :"String", masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, fullId :true});
client.cat.plugins( { format :"String", local :true, masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true});
client.cat.recovery( { format :"String", local :true, masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, index :"String_String[]_Boolean"});
client.cat.repositories( { format :"String", bytes :"String", masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true});
client.cat.segments( { format :"String", local :true, h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, index :"String_String[]_Boolean"});
client.cat.shards( { format :"String", bytes :"String", local :true, masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, index :"String_String[]_Boolean"});
client.cat.snapshots( { format :"String", bytes :"String", masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, repository :"String_String[]_Boolean"});
client.cat.tasks( { format :"String", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, actions :"String_String[]_Boolean", parentTask : 99999, ignoreUnavailable :true, detailed :true});
client.cat.templates( { format :"String", masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, name :"String", nodeId :"String_String[]_Boolean"});
client.cat.threadPool( { format :"String", local :true, masterTimeout :"2019-01-01", h :"String_String[]_Boolean", help :true, s :"String_String[]_Boolean", v :true, threadPoolPatterns :"String_String[]_Boolean"});
client.cluster.allocationExplain( { includeYesDecisions :true, size :"String", body : {}});
client.cluster.getSettings( { flatSettings :true, includeDiskInfo :true, timeout :"2019-01-01", includeDefaults :true});
client.cluster.health( { [level=cluster] :"String", masterTimeout :"2019-01-01", masterTimeout :"2019-01-01", timeout :"2019-01-01", waitForActiveShards :"String", waitForNodes :"String", waitForEvents :"String", waitForNoRelocatingShards :true, waitForNoInitializingShards :true, waitForStatus :"String", index :"String_String[]_Boolean"});
client.cluster.pendingTasks( { local :true});
client.cluster.putSettings( { flatSettings :true, masterTimeout :"2019-01-01", timeout :"2019-01-01", body : {}});
client.cluster.remoteInfo( { masterTimeout :"2019-01-01"});
client.cluster.reroute( { dryRun :true, retryFailed :true, metric :"String_String[]_Boolean", masterTimeout :"2019-01-01", timeout :"2019-01-01", body : {}});
client.cluster.state( { local :true, explain :true, flatSettings :true, ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", index :"String_String[]_Boolean", metric :"String_String[]_Boolean"});
client.cluster.stats( { flatSettings :true, masterTimeout :"2019-01-01", nodeId :"String_String[]_Boolean"});
client.indices.analyze( { timeout :"2019-01-01", index :"String", body : {} });
client.indices.clearCache( { fieldData :true, fields :"String_String[]_Boolean", query :true, ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", index :"String_String[]_Boolean", requestCache :true, request :true, body : {} });
client.indices.close( { fielddata :true, timeout :"2019-01-01", masterTimeout :"2019-01-01", ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", index :"String_String[]_Boolean", body : {} });
client.indices.create( { waitForActiveShards :"String", timeout :"2019-01-01", masterTimeout :"2019-01-01", updateAllTypes :true, index :"String", body : {} });
client.indices.delete( { timeout :"2019-01-01", masterTimeout :"2019-01-01", ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", index :"String_String[]_Boolean", body : {} });
client.indices.deleteAlias( { timeout :"2019-01-01", masterTimeout :"2019-01-01", index :"String_String[]_Boolean", name :"String_String[]_Boolean", body : {} });
client.indices.deleteTemplate( { timeout :"2019-01-01", masterTimeout :"2019-01-01", name :"String", body : {} });
client.indices.exists( { local :true, ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", flatSettings :true, includeDefaults :true, index :"String_String[]_Boolean", body : {} });
client.indices.existsAlias( { ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=all] :"String", local :true, index :"String_String[]_Boolean", name :"String_String[]_Boolean", body : {} });
client.indices.existsTemplate( { flatSettings :true, masterTimeout :"2019-01-01", local :true, name :"String_String[]_Boolean", body : {} });
client.indices.existsType( { ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", local :true, index :"String_String[]_Boolean", type :"String_String[]_Boolean", body : {} });
client.indices.flush( { force :true, ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", index :"String_String[]_Boolean", body : {} });
client.indices.flushSynced( { waitIfOngoing :true, ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", index :"String_String[]_Boolean", body : {} });
client.indices.forcemerge( { flush :true, ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", maxNumSegments : 99999, onlyExpungeDeletes :true, index :"String_String[]_Boolean", body : {} });
client.indices.get( { local :true, ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", flatSettings :true, includeDefaults :true, masterTimeout :"2019-01-01", index :"String_String[]_Boolean", body : {} });
client.indices.getAlias( { ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=all] :"String", local :true, index :"String_String[]_Boolean", name :"String_String[]_Boolean"});
client.indices.getFieldMapping( { includeDefaults :true, ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", local :true, index :"String_String[]_Boolean", type :"String_String[]_Boolean", fields :"String_String[]_Boolean"});
client.indices.getMapping( { ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", masterTimeout :"2019-01-01", local :true, index :"String_String[]_Boolean", type :"String_String[]_Boolean"});
client.indices.getSettings( { masterTimeout :"2019-01-01", ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open,closed] :"String", flatSettings :true, local :true, includeDefaults :true, index :"String_String[]_Boolean", name :"String_String[]_Boolean"});
client.indices.getTemplate( { flatSettings :true, masterTimeout :"2019-01-01", local :true, name :"String_String[]_Boolean"});
client.indices.getUpgrade( { ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", index :"String_String[]_Boolean"});
client.indices.open( { timeout :"2019-01-01", masterTimeout :"2019-01-01", ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=closed] :"String", waitForActiveShards :"String", index :"String_String[]_Boolean"});
client.indices.putAlias( { timeout :"2019-01-01", masterTimeout :"2019-01-01", index :"String_String[]_Boolean", name :"String", body : {} });
client.indices.putMapping( { timeout :"2019-01-01", masterTimeout :"2019-01-01", ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", updateAllTypes :true, index :"String_String[]_Boolean", type :"String", body : {} });
client.indices.putSettings( { timeout :"2019-01-01", preserveExisting :true, ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", flatSettings :true, index :"String_String[]_Boolean", body : {} });
client.indices.putTemplate( { order : 99999, masterTimeout :"2019-01-01", timeout :"2019-01-01", masterTimeout :"2019-01-01", flatSettings :true, name :"String", body : {} });
client.indices.recovery( { detailed :true, create :true, index :"String_String[]_Boolean", body : {} });
client.indices.refresh( { activeOnly :true, ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", index :"String_String[]_Boolean"});
client.indices.rollover( { timeout :"2019-01-01", masterTimeout :"2019-01-01", waitForActiveShards :"String", alias :"String", newIndex :"String"});
client.indices.segments( { dryRun :true, ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", verbose :true, index :"String_String[]_Boolean", body : {} });
client.indices.shardStores( { status :"String_String[]_Boolean", ignoreUnavailable :true, allowNoIndices :true, [expandWildcards=open] :"String", index :"String_String[]_Boolean"});
client.indices.shrink( { copySettings :true, timeout :"2019-01-01", masterTimeout :"2019-01-01", waitForActiveShards :"String", index :"String", target :"String", body : {} });
client.indices.split( { copySettings :true, timeout :"2019-01-01", masterTimeout :"2019-01-01", waitForActiveShards :"String", index :"String", target :"String", body : {} });
client.indices.stats( { completionFields :"String_String[]_Boolean", fields :"String_String[]_Boolean", groups :"String_String[]_Boolean", [level=indices] :"String", types :"String_String[]_Boolean", includeSegmentFileSizes :true, index :"String_String[]_Boolean", metric :"String_String[]_Boolean", body : {} });
client.indices.updateAliases( { fielddataFields :"String_String[]_Boolean", timeout :"2019-01-01", masterTimeout :"2019-01-01"});
client.indices.upgrade( { allowNoIndices :true, [expandWildcards=open] :"String", ignoreUnavailable :true, waitForCompletion :true, onlyAncientSegments :true, index :"String_String[]_Boolean", body : {} });
client.indices.validateQuery( { explain :true, allowNoIndices :true, [expandWildcards=open] :"String", q :"String", analyzer :"String", analyzeWildcard :true, [defaultOperator=OR] :"String", df :"String", lenient :true, rewrite :true, allShards :true, index :"String_String[]_Boolean", type :"String_String[]_Boolean", body : {} });
client.ingest.deletePipeline( { masterTimeout :"2019-01-01", ignoreUnavailable :true, id :"String", body : {}});
client.ingest.getPipeline( { masterTimeout :"2019-01-01", timeout :"2019-01-01", id :"String"});
client.ingest.processorGrok( "省略");
client.ingest.putPipeline( { masterTimeout :"2019-01-01", id :"String", body : {}});
client.ingest.simulate( { verbose :true, timeout :"2019-01-01", id :"String", body : {}});
client.nodes.hotThreads( { interval :"2019-01-01", threads : 99999, ignoreIdleThreads :true, type :"String", timeout :"2019-01-01", nodeId :"String_String[]_Boolean"});
client.nodes.info( { flatSettings :true, snapshots : 99999, timeout :"2019-01-01", nodeId :"String_String[]_Boolean", metric :"String_String[]_Boolean"});
client.nodes.reloadSecureSettings( { nodeId :"String_String[]_Boolean", body : {}});
client.nodes.stats( { completionFields :"String_String[]_Boolean", fields :"String_String[]_Boolean", groups :true, [level=node] :"String", types :"String_String[]_Boolean", timeout :"2019-01-01", includeSegmentFileSizes :true, metric :"String_String[]_Boolean", indexMetric :"String_String[]_Boolean", nodeId :"String_String[]_Boolean"});
client.nodes.usage( { fielddataFields :"String_String[]_Boolean", metric :"String_String[]_Boolean", nodeId :"String_String[]_Boolean"});
client.snapshot.create( { masterTimeout :"2019-01-01", repository :"String", snapshot :"String", body : {}});
client.snapshot.createRepository( { masterTimeout :"2019-01-01", waitForCompletion :true, verify :true, repository :"String", body : {}});
client.snapshot.delete( { masterTimeout :"2019-01-01", timeout :"2019-01-01", repository :"String", snapshot :"String", body : {}});
client.snapshot.deleteRepository( { masterTimeout :"2019-01-01", repository :"String_String[]_Boolean", body : {}});
client.snapshot.get( { masterTimeout :"2019-01-01", timeout :"2019-01-01", verbose :true, repository :"String", snapshot :"String_String[]_Boolean"});
client.snapshot.getRepository( { masterTimeout :"2019-01-01", ignoreUnavailable :true, repository :"String_String[]_Boolean"});
client.snapshot.restore( { masterTimeout :"2019-01-01", local :true, repository :"String", snapshot :"String", body : {}});
client.snapshot.status( { masterTimeout :"2019-01-01", waitForCompletion :true, repository :"String", snapshot :"String_String[]_Boolean"});
client.snapshot.verifyRepository( { masterTimeout :"2019-01-01", ignoreUnavailable :true, repository :"String", body : {}});
client.tasks.cancel( { nodes :"String_String[]_Boolean", timeout :"2019-01-01", parentTaskId :"String", taskId :"String", body : {}});
client.tasks.get( { actions :"String_String[]_Boolean", taskId :"String"});
client.tasks.list( { nodes :"String_String[]_Boolean", timeout :"2019-01-01", detailed :true, parentTaskId :"String", waitForCompletion :true, [groupBy=nodes] :"String", timeout :"2019-01-01"});
まとめた割にはコピペビリティも一覧性も高くない...
table版
他のものは、オレオレ視点で並び替えや編集を加えていますが、これは公式の並び順に合わせています。
(コピペミスなどで抜け等あるかもしれませんが。)
無印
項番 |
グループ |
API |
ひとこと概要 |
引数 |
引数の項目名と型 |
1 |
トップ |
bulk 公式 |
”バルク”のAPI |
[params, [callback]] |
◆ waitForActiveShards ◇String ◆refresh ◇String ◆routing ◇String ◆timeout ◇DurationString ◆type ◇String ◆fields ◇String,String,Boolean ◆source ◇String,String,Boolean ◆sourceExclude ◇String,String,Boolean ◆_sourceInclude ◇String,String,Boolean ◆pipeline ◇String ◆index ◇String ◆body ◇Object ◆JSONLines |
2 |
トップ |
clearScroll 公式 |
scroll検索のクリア |
[params, [callback]] |
◆ scrollId ◇String,String,Boolean ◆body ◇Object ,JSON |
3 |
トップ |
count 公式 |
件数カウント |
[params, [callback]] |
◆ ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆minScore ◇Number ◆preference ◇String ◆routing ◇String,String,Boolean ◆q ◇String ◆analyzer ◇String ◆analyzeWildcard ◇Boolean ◆[defaultOperator=OR] ◇String ◆df ◇String ◆lenient ◇Boolean ◆terminateAfter ◇Number ◆index ◇String,String,Boolean ◆type ◇String,String,Boolean ◆body ◇Object ,JSON |
4 |
トップ |
create 公式 |
create全般 |
[params, [callback]] |
◆ waitForActiveShards ◇String ◆parent ◇String ◆refresh ◇String ◆routing ◇String ◆timeout ◇DurationString ◆version ◇Number ◆versionType ◇String ◆pipeline ◇String ◆id ◇String ◆index ◇String ◆type ◇String ◆body ◇Object ,JSON |
5 |
トップ |
delete 公式 |
削除 by id |
[params, [callback]] |
◆ waitForActiveShards ◇String ◆parent ◇String ◆refresh ◇String ◆routing ◇String ◆timeout ◇DurationString ◆version ◇Number ◆versionType ◇String ◆id ◇String ◆index ◇String ◆type ◇String ◆body ◇Object ,JSON |
6 |
トップ |
deleteByQuery 公式 |
deleteByQuery |
[params, [callback]] |
◆ analyzer ◇String ◆analyzeWildcard ◇Boolean ◆[defaultOperator=OR] ◇String ◆df ◇String ◆from ◇Number ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[conflicts=abort] ◇String ◆[expandWildcards=open] ◇String ◆lenient ◇Boolean ◆preference ◇String ◆q ◇String ◆routing ◇String,String,Boolean ◆scroll ◇DurationString ◆searchType ◇String ◆searchTimeout ◇DurationString ◆size ◇Number |
|
|
公式 |
|
|
◆sort ◇String,String,Boolean ◆source ◇String,String,Boolean ◆sourceExclude ◇String,String,Boolean ◆_sourceInclude ◇String,String,Boolean ◆terminateAfter ◇Number ◆stats ◇String,String,Boolean ◆version ◇Boolean ◆requestCache ◇Boolean ◆refresh ◇Boolean ◆[timeout=1m] ◇DurationString ◆waitForActiveShards ◇String ◆scrollSize ◇Number ◆[waitForCompletion=true] ◇Boolean ◆requestsPerSecond ◇Number ◆[slices=1] ◇Number ◆index ◇String,String,Boolean ◆type ◇String,String,Boolean ◆body ◇Object ,JSON |
7 |
トップ |
deleteByQueryRethrottle 公式 |
deleteByQueryリスロットル |
[params, [callback]] |
◆ requestsPerSecond ◇Number ◆taskId ◇String ◆body ◇Object ,JSON |
8 |
トップ |
deleteScript 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆masterTimeout ◇DurationString ◆id ◇String ◆body ◇Object ,JSON |
9 |
トップ |
exists 公式 |
|
[params, [callback]] |
◆ storedFields ◇String,String,Boolean ◆parent ◇String ◆preference ◇String ◆realtime ◇Boolean ◆refresh ◇Boolean ◆routing ◇String ◆source ◇String,String,Boolean ◆sourceExclude ◇String,String,Boolean ◆_sourceInclude ◇String,String,Boolean ◆version ◇Number ◆versionType ◇String ◆id ◇String ◆index ◇String ◆type ◇String ◆body ◇Object ,JSON |
10 |
トップ |
existsSource 公式 |
|
[params, [callback]] |
◆ parent ◇String ◆preference ◇String ◆realtime ◇Boolean ◆refresh ◇Boolean ◆routing ◇String ◆source ◇String,String,Boolean ◆sourceExclude ◇String,String,Boolean ◆_sourceInclude ◇String,String,Boolean ◆version ◇Number ◆versionType ◇String ◆id ◇String ◆index ◇String ◆type ◇String ◆body ◇Object ,JSON |
11 |
トップ |
explain 公式 |
|
[params, [callback]] |
◆ analyzeWildcard ◇Boolean ◆analyzer ◇String ◆[defaultOperator=OR] ◇String ◆df ◇String ◆storedFields ◇String,String,Boolean ◆lenient ◇Boolean ◆parent ◇String ◆preference ◇String ◆q ◇String ◆routing ◇String ◆source ◇String,String,Boolean ◆sourceExclude ◇String,String,Boolean ◆_sourceInclude ◇String,String,Boolean ◆id ◇String ◆index ◇String ◆type ◇String ◆body ◇Object ,JSON |
12 |
トップ |
fieldCaps 公式 |
fieldCapsを確認 |
[params, [callback]] |
◆ fields ◇String,String,Boolean ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
13 |
トップ |
get 公式 |
JSONドキュメントを取得 by id |
[params, [callback]] |
◆ storedFields ◇String,String,Boolean ◆parent ◇String ◆preference ◇String ◆realtime ◇Boolean ◆refresh ◇Boolean ◆routing ◇String ◆source ◇String,String,Boolean ◆sourceExclude ◇String,String,Boolean ◆_sourceInclude ◇String,String,Boolean ◆version ◇Number ◆versionType ◇String ◆id ◇String ◆index ◇String ◆type ◇String |
14 |
トップ |
getScript 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆id ◇String ◆ |
15 |
トップ |
getSource 公式 |
sourceのみ取得by id |
[params, [callback]] |
◆ parent ◇String ◆preference ◇String ◆realtime ◇Boolean ◆refresh ◇Boolean ◆routing ◇String ◆source ◇String,String,Boolean ◆sourceExclude ◇String,String,Boolean ◆_sourceInclude ◇String,String,Boolean ◆version ◇Number ◆versionType ◇String ◆id ◇String ◆index ◇String ◆type ◇String |
16 |
トップ |
index 公式 |
CRUD全部 |
[params, [callback]] |
◆ ◆waitForActiveShards ◇String ◆[opType=index] ◇String ◆parent ◇String ◆refresh ◇String ◆routing ◇String ◆timeout ◇DurationString ◆version ◇Number ◆versionType ◇String ◆pipeline ◇String ◆id ◇String ◆index ◇String ◆type ◇String ◆body ◇Object ,JSON |
17 |
トップ |
info 公式 |
クラスターのbasic infoを取得 |
[params, [callback]] |
|
18 |
トップ |
mget 公式 |
mult系 |
[params, [callback]] |
◆ storedFields ◇String,String,Boolean ◆preference ◇String ◆realtime ◇Boolean ◆refresh ◇Boolean ◆routing ◇String ◆source ◇String,String,Boolean ◆sourceExclude ◇String,String,Boolean ◆_sourceInclude ◇String,String,Boolean ◆index ◇String ◆type ◇String ◆body ◇Object ,JSON |
19 |
トップ |
msearch 公式 |
mult系 |
[params, [callback]] |
◆ searchType ◇String ◆maxConcurrentSearches ◇Number ◆typedKeys ◇Boolean ◆[preFilterShardSize=128] ◇Number ◆[maxConcurrentShardRequests=The default grows with the number of nodes in the cluster but is at most 256.] ◇Number ◆index ◇String,String,Boolean ◆type ◇String,String,Boolean ◆body ◇Object ◆JSONLines |
20 |
トップ |
msearchTemplate 公式 |
mult系 |
[params, [callback]] |
◆ searchType ◇String ◆typedKeys ◇Boolean ◆maxConcurrentSearches ◇Number ◆index ◇String,String,Boolean ◆type ◇String,String,Boolean ◆body ◇Object ◆JSONLines |
21 |
トップ |
mtermvectors 公式 |
|
[params, [callback]] |
◆ ids ◇String,String,Boolean ◆termStatistics ◇Boolean ◆[fieldStatistics=true] ◇Boolean ◆fields ◇String,String,Boolean ◆[offsets=true] ◇Boolean ◆[positions=true] ◇Boolean ◆[payloads=true] ◇Boolean ◆preference ◇String ◆routing ◇String ◆parent ◇String ◆realtime ◇Boolean ◆version ◇Number ◆versionType ◇String ◆index ◇String ◆type ◇String ◆body ◇Object ,JSON |
22 |
トップ |
ping 公式 |
|
[params, [callback]] |
|
23 |
トップ |
putScript 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆masterTimeout ◇DurationString ◆context ◇String ◆id ◇String ◆body ◇Object ,JSON |
24 |
トップ |
rankEval 公式 |
|
[params, [callback]] |
◆ ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
25 |
トップ |
reindex 公式 |
|
[params, [callback]] |
◆ refresh ◇Boolean ◆[timeout=1m] ◇DurationString ◆waitForActiveShards ◇String ◆[waitForCompletion=true] ◇Boolean ◆requestsPerSecond ◇Number ◆[slices=1] ◇Number ◆body ◇Object ,JSON |
26 |
トップ |
reindexRethrottle 公式 |
|
[params, [callback]] |
◆ requestsPerSecond ◇Number ◆taskId ◇String ◆body ◇Object ,JSON |
27 |
トップ |
renderSearchTemplate 公式 |
|
[params, [callback]] |
◆ id ◇String ◆body ◇Object ,JSON |
28 |
トップ |
scriptsPainlessExecute 公式 |
|
[params, [callback]] |
|
29 |
トップ |
scroll 公式 |
scroll検索 |
[params, [callback]] |
◆ scroll ◇DurationString ◆scrollId ◇String ◆body ◇Object ,JSON |
30 |
トップ |
search 公式 |
search |
[params, [callback]] |
◆ analyzer ◇String ◆analyzeWildcard ◇Boolean ◆[defaultOperator=OR] ◇String ◆df ◇String ◆explain ◇Boolean ◆storedFields ◇String,String,Boolean ◆docvalueFields ◇String,String,Boolean ◆from ◇Number ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆lenient ◇Boolean ◆preference ◇String ◆q ◇String ◆routing ◇String,String,Boolean ◆scroll ◇DurationString ◆searchType ◇String ◆size ◇Number |
|
|
公式 |
|
|
◆sort ◇String,String,Boolean ◆source ◇String,String,Boolean ◆sourceExclude ◇String,String,Boolean ◆_sourceInclude ◇String,String,Boolean ◆terminateAfter ◇Number ◆stats ◇String,String,Boolean ◆suggestField ◇String ◆[suggestMode=missing] ◇String ◆suggestSize ◇Number ◆suggestText ◇String ◆timeout ◇DurationString ◆trackScores ◇Boolean ◆trackTotalHits ◇Boolean ◆[allowPartialSearchResults=true] ◇Boolean ◆typedKeys ◇Boolean ◆version ◇Boolean ◆requestCache ◇Boolean ◆[batchedReduceSize=512] ◇Number ◆[maxConcurrentShardRequests=The default grows with the number of nodes in the cluster but is at most 256.] ◇Number ◆[preFilterShardSize=128] ◇Number ◆index ◇String,String,Boolean ◆type ◇String,String,Boolean ◆body ◇Object ,JSON |
31 |
トップ |
searchShards 公式 |
|
[params, [callback]] |
◆ preference ◇String ◆routing ◇String ◆local ◇Boolean ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
32 |
トップ |
searchTemplate 公式 |
|
[params, [callback]] |
◆ ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆preference ◇String ◆routing ◇String,String,Boolean ◆scroll ◇DurationString ◆searchType ◇String ◆explain ◇Boolean ◆profile ◇Boolean ◆typedKeys ◇Boolean ◆index ◇String,String,Boolean ◆type ◇String,String,Boolean ◆body ◇Object ,JSON |
33 |
トップ |
termvectors 公式 |
|
[params, [callback]] |
◆ termStatistics ◇Boolean ◆[fieldStatistics=true] ◇Boolean ◆fields ◇String,String,Boolean ◆[offsets=true] ◇Boolean ◆[positions=true] ◇Boolean ◆[payloads=true] ◇Boolean ◆preference ◇String ◆routing ◇String ◆parent ◇String ◆realtime ◇Boolean ◆version ◇Number ◆versionType ◇String ◆index ◇String ◆type ◇String ◆id ◇String ◆body ◇Object ,JSON |
34 |
トップ |
update 公式 |
update(script利用可能) |
[params, [callback]] |
◆ waitForActiveShards ◇String ◆fields ◇String,String,Boolean ◆source ◇String,String,Boolean ◆sourceExclude ◇String,String,Boolean ◆_sourceInclude ◇String,String,Boolean ◆lang ◇String ◆parent ◇String ◆refresh ◇String ◆retryOnConflict ◇Number ◆routing ◇String ◆timeout ◇DurationString ◆version ◇Number ◆versionType ◇String ◆id ◇String ◆index ◇String ◆type ◇String ◆body ◇Object ,JSON |
35 |
トップ |
updateByQuery 公式 |
updateByQuery |
[params, [callback]] |
◆ analyzer ◇String ◆analyzeWildcard ◇Boolean ◆[defaultOperator=OR] ◇String ◆df ◇String ◆from ◇Number ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[conflicts=abort] ◇String ◆[expandWildcards=open] ◇String ◆lenient ◇Boolean ◆pipeline ◇String ◆preference ◇String ◆q ◇String ◆routing ◇String,String,Boolean ◆scroll ◇DurationString ◆searchType ◇String ◆searchTimeout ◇DurationString ◆size ◇Number ◆sort ◇String,String,Boolean |
|
|
公式 |
|
|
◆source ◇String,String,Boolean ◆sourceExclude ◇String,String,Boolean ◆_sourceInclude ◇String,String,Boolean ◆terminateAfter ◇Number ◆stats ◇String,String,Boolean ◆version ◇Boolean ◆versionType ◇Boolean ◆requestCache ◇Boolean ◆refresh ◇Boolean ◆[timeout=1m] ◇DurationString ◆waitForActiveShards ◇String ◆scrollSize ◇Number ◆[waitForCompletion=true] ◇Boolean ◆requestsPerSecond ◇Number ◆[slices=1] ◇Number ◆index ◇String,String,Boolean ◆type ◇String,String,Boolean ◆body ◇Object ,JSON |
36 |
トップ |
updateByQueryRethrottle 公式 |
updateByQueryリスロットル |
[params, [callback]] |
◆ requestsPerSecond ◇Number ◆taskId ◇String ◆body ◇Object ,JSON |
cat、cluster, indices
項番 |
グループ |
API |
ひとこと概要 |
引数 |
引数の項目名と型 |
37 |
cat |
aliases 公式 |
|
[params, [callback]] |
◆ format ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean ◆name ◇String,String,Boolean |
38 |
cat |
allocation 公式 |
|
[params, [callback]] |
◆ format ◇String ◆bytes ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean ◆nodeId ◇String,String,Boolean |
39 |
cat |
count 公式 |
|
[params, [callback]] |
◆ format ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean ◆index ◇String,String,Boolean |
40 |
cat |
fielddata 公式 |
|
[params, [callback]] |
◆ format ◇String ◆bytes ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean ◆fields ◇String,String,Boolean |
41 |
cat |
health 公式 |
|
[params, [callback]] |
◆ format ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆[ts=true] ◇Boolean ◆v ◇Boolean |
42 |
cat |
help 公式 |
|
[params, [callback]] |
◆ help ◇Boolean ◆s ◇String,String,Boolean ◆ |
43 |
cat |
indices 公式 |
|
[params, [callback]] |
◆ format ◇String ◆bytes ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆health ◇String ◆help ◇Boolean ◆pri ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean ◆index ◇String,String,Boolean |
44 |
cat |
master 公式 |
|
[params, [callback]] |
◆ format ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean |
45 |
cat |
nodeattrs 公式 |
|
[params, [callback]] |
◆ format ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean |
46 |
cat |
nodes 公式 |
|
[params, [callback]] |
◆ format ◇String ◆fullId ◇Boolean ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean |
47 |
cat |
pendingTasks 公式 |
|
[params, [callback]] |
◆ format ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean |
48 |
cat |
plugins 公式 |
|
[params, [callback]] |
◆ format ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean |
49 |
cat |
recovery 公式 |
|
[params, [callback]] |
◆ format ◇String ◆bytes ◇String ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean ◆index ◇String,String,Boolean |
50 |
cat |
repositories 公式 |
|
[params, [callback]] |
◆ format ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean |
51 |
cat |
segments 公式 |
|
[params, [callback]] |
◆ format ◇String ◆bytes ◇String ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean ◆index ◇String,String,Boolean |
52 |
cat |
shards 公式 |
|
[params, [callback]] |
◆ format ◇String ◆bytes ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean ◆index ◇String,String,Boolean |
53 |
cat |
snapshots 公式 |
|
[params, [callback]] |
◆ format ◇String ◆ignoreUnavailable ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean ◆repository ◇String,String,Boolean |
54 |
cat |
tasks 公式 |
|
[params, [callback]] |
◆ format ◇String ◆nodeId ◇String,String,Boolean ◆actions ◇String,String,Boolean ◆detailed ◇Boolean ◆parentTask ◇Number ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean |
55 |
cat |
templates 公式 |
|
[params, [callback]] |
◆ format ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean ◆name ◇String |
56 |
cat |
threadPool 公式 |
|
[params, [callback]] |
◆ format ◇String ◆size ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆h ◇String,String,Boolean ◆help ◇Boolean ◆s ◇String,String,Boolean ◆v ◇Boolean ◆threadPoolPatterns ◇String,String,Boolean |
57 |
cluster |
allocationExplain 公式 |
|
[params, [callback]] |
◆ includeYesDecisions ◇Boolean ◆includeDiskInfo ◇Boolean ◆body ◇Object ,JSON |
58 |
cluster |
getSettings 公式 |
|
[params, [callback]] |
◆ flatSettings ◇Boolean ◆masterTimeout ◇DurationString ◆timeout ◇DurationString ◆includeDefaults ◇Boolean |
59 |
cluster |
health 公式 |
|
[params, [callback]] |
◆ [level=cluster] ◇String ◆local ◇Boolean ◆masterTimeout ◇DurationString ◆timeout ◇DurationString ◆waitForActiveShards ◇String ◆waitForNodes ◇String ◆waitForEvents ◇String ◆waitForNoRelocatingShards ◇Boolean ◆waitForNoInitializingShards ◇Boolean ◆waitForStatus ◇String ◆index ◇String,String,Boolean |
60 |
cluster |
pendingTasks 公式 |
|
[params, [callback]] |
◆ local ◇Boolean ◆masterTimeout ◇DurationString |
61 |
cluster |
putSettings 公式 |
|
[params, [callback]] |
◆ flatSettings ◇Boolean ◆masterTimeout ◇DurationString ◆timeout ◇DurationString ◆body ◇Object ,JSON |
62 |
cluster |
remoteInfo 公式 |
|
[params, [callback]] |
|
63 |
cluster |
reroute 公式 |
|
[params, [callback]] |
◆ dryRun ◇Boolean ◆explain ◇Boolean ◆retryFailed ◇Boolean ◆metric ◇String,String,Boolean ◆masterTimeout ◇DurationString ◆timeout ◇DurationString ◆body ◇Object ,JSON |
64 |
cluster |
state 公式 |
|
[params, [callback]] |
◆ local ◇Boolean ◆masterTimeout ◇DurationString ◆flatSettings ◇Boolean ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆index ◇String,String,Boolean ◆metric ◇String,String,Boolean |
65 |
cluster |
stats 公式 |
|
[params, [callback]] |
◆ flatSettings ◇Boolean ◆timeout ◇DurationString ◆nodeId ◇String,String,Boolean |
66 |
indices |
analyze 公式 |
|
[params, [callback]] |
◆ index ◇String ◆body ◇Object ,JSON |
67 |
indices |
clearCache 公式 |
|
[params, [callback]] |
◆ fieldData ◇Boolean ◆fielddata ◇Boolean ◆fields ◇String,String,Boolean ◆query ◇Boolean ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆index ◇String,String,Boolean ◆requestCache ◇Boolean ◆request ◇Boolean ◆body ◇Object ,JSON |
68 |
indices |
close 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆masterTimeout ◇DurationString ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
69 |
indices |
create 公式 |
|
[params, [callback]] |
◆ waitForActiveShards ◇String ◆timeout ◇DurationString ◆masterTimeout ◇DurationString ◆updateAllTypes ◇Boolean ◆index ◇String ◆body ◇Object ,JSON |
70 |
indices |
delete 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆masterTimeout ◇DurationString ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
71 |
indices |
deleteAlias 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆masterTimeout ◇DurationString ◆index ◇String,String,Boolean ◆name ◇String,String,Boolean ◆body ◇Object ,JSON |
72 |
indices |
deleteTemplate 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆masterTimeout ◇DurationString ◆name ◇String ◆body ◇Object ,JSON |
73 |
indices |
exists 公式 |
|
[params, [callback]] |
◆ local ◇Boolean ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆flatSettings ◇Boolean ◆includeDefaults ◇Boolean ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
74 |
indices |
existsAlias 公式 |
|
[params, [callback]] |
◆ ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=all] ◇String ◆local ◇Boolean ◆index ◇String,String,Boolean ◆name ◇String,String,Boolean ◆body ◇Object ,JSON |
75 |
indices |
existsTemplate 公式 |
|
[params, [callback]] |
◆ flatSettings ◇Boolean ◆masterTimeout ◇DurationString ◆local ◇Boolean ◆name ◇String,String,Boolean ◆body ◇Object ,JSON |
76 |
indices |
existsType 公式 |
|
[params, [callback]] |
◆ ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆local ◇Boolean ◆index ◇String,String,Boolean ◆type ◇String,String,Boolean ◆body ◇Object ,JSON |
77 |
indices |
flush 公式 |
|
[params, [callback]] |
◆ force ◇Boolean ◆waitIfOngoing ◇Boolean ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
78 |
indices |
flushSynced 公式 |
|
[params, [callback]] |
◆ ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
79 |
indices |
forcemerge 公式 |
|
[params, [callback]] |
◆ flush ◇Boolean ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆maxNumSegments ◇Number ◆onlyExpungeDeletes ◇Boolean ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
80 |
indices |
get 公式 |
|
[params, [callback]] |
◆ local ◇Boolean ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆flatSettings ◇Boolean ◆includeDefaults ◇Boolean ◆masterTimeout ◇DurationString ◆index ◇String,String,Boolean |
81 |
indices |
getAlias 公式 |
|
[params, [callback]] |
◆ ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=all] ◇String ◆local ◇Boolean ◆index ◇String,String,Boolean ◆name ◇String,String,Boolean ◆ |
82 |
indices |
getFieldMapping 公式 |
|
[params, [callback]] |
◆ includeDefaults ◇Boolean ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆local ◇Boolean ◆index ◇String,String,Boolean ◆type ◇String,String,Boolean ◆fields ◇String,String,Boolean |
83 |
indices |
getMapping 公式 |
|
[params, [callback]] |
◆ ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆masterTimeout ◇DurationString ◆local ◇Boolean ◆index ◇String,String,Boolean ◆type ◇String,String,Boolean ◆ |
84 |
indices |
getSettings 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open,closed] ◇String ◆flatSettings ◇Boolean ◆local ◇Boolean ◆includeDefaults ◇Boolean ◆index ◇String,String,Boolean ◆name ◇String,String,Boolean |
85 |
indices |
getTemplate 公式 |
|
[params, [callback]] |
◆ flatSettings ◇Boolean ◆masterTimeout ◇DurationString ◆local ◇Boolean ◆name ◇String,String,Boolean |
86 |
indices |
getUpgrade 公式 |
|
[params, [callback]] |
◆ ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆index ◇String,String,Boolean |
87 |
indices |
open 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆masterTimeout ◇DurationString ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=closed] ◇String ◆waitForActiveShards ◇String ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
88 |
indices |
putAlias 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆masterTimeout ◇DurationString ◆index ◇String,String,Boolean ◆name ◇String ◆body ◇Object ,JSON |
89 |
indices |
putMapping 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆masterTimeout ◇DurationString ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆updateAllTypes ◇Boolean ◆index ◇String,String,Boolean ◆type ◇String ◆body ◇Object ,JSON |
90 |
indices |
putSettings 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆timeout ◇DurationString ◆preserveExisting ◇Boolean ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆flatSettings ◇Boolean ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
91 |
indices |
putTemplate 公式 |
|
[params, [callback]] |
◆ order ◇Number ◆create ◇Boolean ◆timeout ◇DurationString ◆masterTimeout ◇DurationString ◆flatSettings ◇Boolean ◆name ◇String ◆body ◇Object ,JSON |
92 |
indices |
recovery 公式 |
|
[params, [callback]] |
◆ detailed ◇Boolean ◆activeOnly ◇Boolean ◆index ◇String,String,Boolean |
93 |
indices |
refresh 公式 |
|
[params, [callback]] |
◆ ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
94 |
indices |
rollover 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆dryRun ◇Boolean ◆masterTimeout ◇DurationString ◆waitForActiveShards ◇String ◆alias ◇String ◆newIndex ◇String ◆body ◇Object ,JSON |
95 |
indices |
segments 公式 |
|
[params, [callback]] |
◆ ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆verbose ◇Boolean ◆index ◇String,String,Boolean ◆ |
96 |
indices |
shardStores 公式 |
|
[params, [callback]] |
◆ status ◇String,String,Boolean ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆index ◇String,String,Boolean ◆ |
97 |
indices |
shrink 公式 |
|
[params, [callback]] |
◆ copySettings ◇Boolean ◆timeout ◇DurationString ◆masterTimeout ◇DurationString ◆waitForActiveShards ◇String ◆index ◇String ◆target ◇String ◆body ◇Object ,JSON |
98 |
indices |
split 公式 |
|
[params, [callback]] |
◆ copySettings ◇Boolean ◆timeout ◇DurationString ◆masterTimeout ◇DurationString ◆waitForActiveShards ◇String ◆index ◇String ◆target ◇String ◆body ◇Object ,JSON |
99 |
indices |
stats 公式 |
|
[params, [callback]] |
◆ completionFields ◇String,String,Boolean ◆fielddataFields ◇String,String,Boolean ◆fields ◇String,String,Boolean ◆groups ◇String,String,Boolean ◆[level=indices] ◇String ◆types ◇String,String,Boolean ◆includeSegmentFileSizes ◇Boolean ◆index ◇String,String,Boolean ◆metric ◇String,String,Boolean |
100 |
indices |
updateAliases 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆masterTimeout ◇DurationString ◆body ◇Object ,JSON |
101 |
indices |
upgrade 公式 |
|
[params, [callback]] |
◆ allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆ignoreUnavailable ◇Boolean ◆waitForCompletion ◇Boolean ◆onlyAncientSegments ◇Boolean ◆index ◇String,String,Boolean ◆body ◇Object ,JSON |
102 |
indices |
validateQuery 公式 |
|
[params, [callback]] |
◆ explain ◇Boolean ◆ignoreUnavailable ◇Boolean ◆allowNoIndices ◇Boolean ◆[expandWildcards=open] ◇String ◆q ◇String ◆analyzer ◇String ◆analyzeWildcard ◇Boolean ◆[defaultOperator=OR] ◇String ◆df ◇String ◆lenient ◇Boolean ◆rewrite ◇Boolean ◆allShards ◇Boolean ◆index ◇String,String,Boolean ◆type ◇String,String,Boolean ◆body ◇Object ,JSON |
ingest, nodes, snapshot, tasks
項番 |
グループ |
API |
ひとこと概要 |
引数 |
引数の項目名と型 |
103 |
ingest |
deletePipeline 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆timeout ◇DurationString ◆id ◇String ◆body ◇Object ,JSON |
104 |
ingest |
getPipeline 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆id ◇String |
105 |
ingest |
processorGrok 公式 |
|
[params, [callback]] |
|
106 |
ingest |
putPipeline 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆timeout ◇DurationString ◆id ◇String ◆body ◇Object ,JSON |
107 |
ingest |
simulate 公式 |
|
[params, [callback]] |
◆ verbose ◇Boolean ◆id ◇String ◆body ◇Object ,JSON |
108 |
nodes |
hotThreads 公式 |
|
[params, [callback]] |
◆ interval ◇DurationString ◆snapshots ◇Number ◆threads ◇Number ◆ignoreIdleThreads ◇Boolean ◆type ◇String ◆timeout ◇DurationString ◆nodeId ◇String,String,Boolean |
109 |
nodes |
info 公式 |
|
[params, [callback]] |
◆ flatSettings ◇Boolean ◆timeout ◇DurationString ◆nodeId ◇String,String,Boolean ◆metric ◇String,String,Boolean |
110 |
nodes |
reloadSecureSettings 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆nodeId ◇String,String,Boolean ◆body ◇Object ,JSON |
111 |
nodes |
stats 公式 |
|
[params, [callback]] |
◆ completionFields ◇String,String,Boolean ◆fielddataFields ◇String,String,Boolean ◆fields ◇String,String,Boolean ◆groups ◇Boolean ◆[level=node] ◇String ◆types ◇String,String,Boolean ◆timeout ◇DurationString ◆includeSegmentFileSizes ◇Boolean ◆metric ◇String,String,Boolean ◆indexMetric ◇String,String,Boolean ◆nodeId ◇String,String,Boolean |
112 |
nodes |
usage 公式 |
|
[params, [callback]] |
◆ timeout ◇DurationString ◆metric ◇String,String,Boolean ◆nodeId ◇String,String,Boolean ◆ |
113 |
snapshot |
create 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆waitForCompletion ◇Boolean ◆repository ◇String ◆snapshot ◇String ◆body ◇Object ,JSON |
114 |
snapshot |
createRepository 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆timeout ◇DurationString ◆verify ◇Boolean ◆repository ◇String ◆body ◇Object ,JSON |
115 |
snapshot |
delete 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆repository ◇String ◆snapshot ◇String ◆body ◇Object ,JSON |
116 |
snapshot |
deleteRepository 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆timeout ◇DurationString ◆repository ◇String,String,Boolean ◆body ◇Object ,JSON |
117 |
snapshot |
get 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆ignoreUnavailable ◇Boolean ◆verbose ◇Boolean ◆repository ◇String ◆snapshot ◇String,String,Boolean |
118 |
snapshot |
getRepository 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆local ◇Boolean ◆repository ◇String,String,Boolean |
119 |
snapshot |
restore 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆waitForCompletion ◇Boolean ◆repository ◇String ◆snapshot ◇String ◆body ◇Object ,JSON |
120 |
snapshot |
status 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆ignoreUnavailable ◇Boolean ◆repository ◇String ◆snapshot ◇String,String,Boolean |
121 |
snapshot |
verifyRepository 公式 |
|
[params, [callback]] |
◆ masterTimeout ◇DurationString ◆timeout ◇DurationString ◆repository ◇String ◆body ◇Object ,JSON |
122 |
tasks |
cancel 公式 |
|
[params, [callback]] |
◆ nodes ◇String,String,Boolean ◆actions ◇String,String,Boolean ◆parentTaskId ◇String ◆taskId ◇String ◆body ◇Object ,JSON |
123 |
tasks |
get 公式 |
|
[params, [callback]] |
◆ waitForCompletion ◇Boolean ◆timeout ◇DurationString ◆taskId ◇String |
124 |
tasks |
list 公式 |
|
[params, [callback]] |
◆ nodes ◇String,String,Boolean ◆actions ◇String,String,Boolean ◆detailed ◇Boolean ◆parentTaskId ◇String ◆waitForCompletion ◇Boolean ◆[groupBy=nodes] ◇String ◆timeout ◇DurationString |