思维导图备注

OpenSearch v2.13 Documentation
首页 白天 夜间 BookChat 小程序 小程序 阅读
  • 书签 我的书签
  • 添加书签 添加书签 移除书签 移除书签

Cluster APIs

 GitHub  来源:OpenSearch 浏览 45 扫码 分享 2024-07-27 11:06:23
  • Cluster APIs
    • Related articles

    Cluster APIs

    Introduced 1.0

    The cluster APIs allow you to manage your cluster. You can use them to check cluster health, modify settings, retrieve statistics, and more.

    Related articles

    • Cluster allocation explain
    • Cluster routing and awareness
    • Cluster decommission
    • Cluster health
    • Cluster settings
    • Cluster stats
    当前内容版权归 OpenSearch 或其关联方所有，如需对内容或内容相关联开源项目进行关注与资助，请访问 OpenSearch .
    上一篇:
    下一篇:
    • 书签
    • 添加书签 移除书签
    • OpenSearch v2.16 Documentation
    • OpenSearch v2.15 Documentation
    • OpenSearch v2.14 Documentation
    • OpenSearch v2.13 Documentation
    • OpenSearch v2.12 Documentation
    • OpenSearch v2.11 Documentation
    • OpenSearch v2.10 Documentation
    • OpenSearch v2.9 Documentation
    • OpenSearch v2.8 Documentation
    • OpenSearch v2.7 Documentation
    • OpenSearch v2.6 Documentation
    • OpenSearch v2.5 Documentation
    • OpenSearch v2.4 Documentation
    • OpenSearch v2.3 Documentation
    • OpenSearch v2.2 Documentation
    • OpenSearch v2.1 Documentation
    • OpenSearch v2.0 Documentation
    • OpenSearch v1.3 Documentation
    • OpenSearch v1.2 Documentation
    • OpenSearch v1.1 Documentation
    • OpenSearch v1.0 Documentation
    • About OpenSearch
      • Version history
      • Breaking changes
    • Getting started
      • Intro to OpenSearch
      • Installation quickstart
      • Communicate with OpenSearch
      • Ingest data
      • Search your data
    • Install and upgrade
      • Installing OpenSearch
        • Docker
        • Helm
        • Tarball
        • RPM
        • Debian
        • Ansible playbook
        • Windows
      • Installing OpenSearch Dashboards
        • Docker
        • Tarball
        • RPM
        • Debian
        • Helm
        • Windows
        • Configure TLS
      • Configuring OpenSearch
        • Configuration and system settings
        • Network settings
        • Discovery and gateway settings
        • Security settings
        • Circuit breaker settings
        • Cluster settings
        • Index settings
        • Search settings
        • Availability and recovery settings
        • Plugin settings
        • Experimental feature flags
        • Logs
      • Configuring OpenSearch Dashboards
      • Upgrading OpenSearch
        • Rolling Upgrade
        • Upgrades appendix
          • Rolling upgrade lab
      • Installing plugins
      • Managing OpenSearch Dashboards plugins
    • Migrate to OpenSearch
      • Using snapshots to migrate data
      • Migrating from Elasticsearch OSS to OpenSearch
      • Migrating Docker clusters to OpenSearch
      • Migrating from Kibana OSS to OpenSearch Dashboards
    • Managing Indexes
      • Index templates
      • Index aliases
      • Data streams
      • Reindex data
      • Index State Management
        • Policies
        • Managed indexes
        • Settings
        • ISM API
      • Index transforms
        • Transforms APIs
      • Index rollups
        • Index rollups API
        • Settings
      • Index management security
      • Refresh search analyzer
      • ISM Error Prevention
        • ISM Error Prevention resolutions
        • ISM Error Prevention API
      • Notification settings
    • Ingest Pipelines
      • Create pipeline
      • Simulate pipeline
      • Get pipeline
      • Delete pipeline
      • Handling pipeline failures
      • Ingest processors
        • Append
        • Bytes
        • Convert
        • Copy
        • CSV
        • Date
        • Community ID
        • Date index name
        • Dissect
        • Dot expander
        • Drop
        • IP2Geo
        • Grok
        • KV
        • Lowercase
        • Remove_by_pattern
        • Remove
        • Rename
        • Sparse encoding
        • Text chunking
        • Text embedding
        • Text/image embedding
        • Uppercase
        • URL decode
        • User agent
    • OpenSearch Dashboards
      • OpenSearch Dashboards quickstart guide
      • OpenSearch Assistant for OpenSearch Dashboards
      • Analyzing data
        • Time filter
      • Creating dashboards
      • Building data visualizations
        • Using area charts
        • Using coordinate and region maps
          • Using maps
          • Maps Stats API
          • Configuring a Web Map Service (WMS)
          • Using the self-host maps server
        • Using Gantt charts
        • Using Vega
        • Using VisBuilder
      • Index Management
        • Indexes
        • Data streams
        • Force merge
        • Rollover
        • Component templates
        • Notification settings
      • Snapshot Management
      • Dashboards Management
        • Index patterns
        • Advanced settings
      • Configuring Content Security Policy rules dynamically
      • Data sources
        • Configuring and using multiple data sources
        • Connecting Amazon S3 to OpenSearch
          • Query and visualize Amazon S3 data
          • Optimize query performance using OpenSearch indexing
      • Dev Tools
        • Running queries in the Dev Tools console
      • Query Workbench
      • Custom branding
      • Dashboards Query Language (DQL)
      • Search telemetry
    • OpenSearch Integrations
    • Creating and tuning your cluster
      • Cluster manager task throttling
      • Cross-cluster replication
        • Getting started
        • Auto-follow
        • Replication security
        • Replication settings
        • API
      • Availability and recovery
        • Snapshots
          • Take and restore snapshots
          • Snapshot management
          • Snapshot management API
          • Searchable snapshots
        • Remote-backed storage
          • Remote cluster state
          • Remote segment backpressure
          • Shallow snapshots
          • Remote Store Stats API
        • Search backpressure
        • Shard indexing backpressure
          • Stats API
          • Settings
        • Segment replication
          • Segment replication backpressure
      • Tuning for indexing speed
    • Security in OpenSearch
      • Configuration
        • Setting up a demo configuration
        • System indexes
        • Configuring the Security backend
        • Modifying the YAML files
        • Configuring TLS certificates
        • Generating self-signed certificates
        • Applying changes to configuration files
        • API rate limiting
        • Configuring sign-in options
        • Disabling and enabling the Security plugin
        • OpenSearch keystore
      • Authentication backends
        • HTTP basic authentication
        • JSON Web Token
        • OpenID Connect
        • SAML
        • Active Directory and LDAP
        • Proxy-based authentication
        • Client certificate authentication
      • Access control
        • REST layer authorization
        • Document-level security
        • Defining users and roles
        • Field-level security
        • Field masking
        • User impersonation
        • Permissions
        • Default action groups
        • API
        • Authorization tokens
        • Anonymous authentication
      • Audit logs
        • Audit log field reference
        • Audit log storage types
      • OpenSearch Dashboards multi-tenancy
        • Multi-tenancy configuration
        • Dynamic configuration in OpenSearch Dashboards
        • Multi-tenancy aggregate view for saved objects
    • Security analytics
      • OpenSearch Security for Security Analytics
      • Setting up Security Analytics
        • Working with log types
        • Creating detectors
        • Creating correlation rules
      • Supported log types
        • AD LDAP
        • Amazon S3
        • Apache Access
        • AWS CloudTrail
        • Azure
        • DNS
        • GitHub
        • Google Workspace
        • Linux
        • Microsoft 365
        • NetFlow
        • Network
        • Okta
        • VPC Flow
        • WAF
        • Windows
        • Other log type mappings
      • Using Security Analytics
        • The Overview page
        • Working with detectors
        • Working with findings
        • Working with detection rules
        • Working with the correlation graph
        • Working with alerts
      • API tools
        • Detector APIs
        • Rule APIs
        • Mappings APIs
        • Alerts and findings APIs
        • Correlation engine APIs
        • Log type APIs
      • Security Analytics settings
    • Mappings and field types
      • Supported field types
        • Alias
        • Binary
        • Numeric field types
          • Unsigned long
        • Boolean
        • Date field types
          • Date
          • Date nanoseconds
        • IP address
        • Range field types
        • Object field types
          • Object
          • Nested
          • Flat object
          • Join
        • String field types
          • Keyword
          • Text
          • Match-only text
          • Token count
        • Autocomplete field types
          • Completion
          • Search as you type
        • Geographic field types
          • Geopoint
          • Geoshape
        • Cartesian field types
          • xy point
          • xy shape
        • k-NN vector
        • Rank field types
        • Percolator
    • Text analysis
      • Language analyzers
      • Index analyzers
      • Search analyzers
      • Tokenizers
      • Token filters
        • Delimited term frequency
      • Normalizers
    • Query DSL
      • Query and filter context
      • Term-level and full-text queries compared
      • Term-level queries
        • Exists
        • Fuzzy
        • IDs
        • Prefix
        • Range
        • Regexp
        • Term
        • Terms
        • Terms set
        • Wildcard
      • Full-text queries
        • Match
        • Match Boolean prefix
        • Match phrase
        • Match phrase prefix
        • Multi-match
        • Query string
        • Simple query string
        • Intervals
      • Compound queries
        • Boolean
        • Boosting
        • Constant score
        • Disjunction max
        • Function score
        • Hybrid
      • Geographic and xy queries
        • Geo-bounding box
        • xy
      • Span queries
      • Match all queries
      • Specialized queries
        • Neural
        • Neural sparse
        • Script score
      • Minimum should match
    • Aggregations
      • Metric aggregations
        • Average
        • Cardinality
        • Extended stats
        • Geobounds
        • Matrix stats
        • Maximum
        • Minimum
        • Percentile ranks
        • Percentile
        • Scripted metric
        • Stats
        • Sum
        • Top hits
        • Value count
      • Bucket aggregations
        • Adjacency matrix
        • Date histogram
        • Date range
        • Diversified sampler
        • Filter
        • Filters
        • Geodistance
        • Geohash grid
        • Geohex grid
        • Geotile grid
        • Global
        • Histogram
        • IP range
        • Missing
        • Multi-terms
        • Nested
        • Range
        • Reverse nested
        • Sampler
        • Significant terms
        • Significant text
        • Terms
      • Pipeline aggregations
    • Search
      • Searching data
        • Paginate results
        • Point in Time
          • Point in Time API
        • Sort results
        • Highlight query matches
        • Autocomplete
        • Did-you-mean
      • Keyword search
      • k-NN search
        • k-NN index
        • Exact k-NN with scoring script
        • Approximate k-NN search
        • k-NN search with filters
        • k-NN search with nested fields
        • k-NN Painless extensions
        • k-NN vector quantization
        • API
        • JNI libraries
        • Settings
        • Performance tuning
      • Neural search
      • Neural search tutorial
      • Semantic search
      • Multimodal search
      • Neural sparse search
      • Hybrid search
      • Cross-cluster search
      • Text chunking
      • Conversational search
      • Search relevance
        • Comparing search results
        • Reranking search results
        • Querqy
      • Search pipelines
        • Creating a search pipeline
        • Using a search pipeline
        • Retrieving search pipelines
        • Search processors
          • Collapse
          • Filter query
          • Neural query enricher
          • Normalization
          • Oversample
          • Personalize search ranking
          • Retrieval-augmented generation
          • Rename field
          • Rerank
          • Script
          • Truncate hits
        • Search pipeline metrics
      • Improving search performance
        • Asynchronous search
          • Asynchronous search security
          • Settings
        • Concurrent segment search
      • SQL and PPL
        • SQL and PPL API
        • Response formats
        • SQL and PPL CLI
        • SQL
          • Basic Queries
          • Complex Queries
          • Functions
          • JSON Support
          • Metadata Queries
          • Aggregate Functions
          • Delete
          • JDBC Driver
          • ODBC Driver
        • PPL
          • Syntax
          • Commands
        • Identifiers
        • Data Types
        • Functions
        • Full-Text Search
        • Settings
        • Troubleshooting
        • Monitoring
        • Limitations
    • Machine learning
      • ML Commons cluster settings
      • Integrating ML models
        • Model access control
        • Using ML models within OpenSearch
          • Custom models
          • Pretrained models
          • GPU acceleration
        • Connecting to externally hosted models
          • Connectors
          • Connector blueprints
          • Guardrails
      • Agents and tools
        • Agents and tools tutorial
        • Tools
          • Agent tool
          • CAT Index tool
          • Index Mapping tool
          • ML Model tool
          • Neural Sparse Search tool
          • PPL tool
          • RAG tool
          • Search Alerts tool
          • Search Anomaly Detectors tool
          • Search Anomaly Results tool
          • Search Index tool
          • Search Monitors tool
          • Vector DB tool
          • Visualization tool
      • OpenSearch Assistant Toolkit
      • Managing ML models in OpenSearch Dashboards
      • Supported algorithms
      • ML Commons APIs
        • Model APIs
          • Register model
          • Deploy model
          • Get model
          • Search model
          • Update model
          • Undeploy model
          • Delete model
        • Model group APIs
          • Register model group
          • Update model group
          • Get model group
          • Search model group
          • Delete model group
        • Connector APIs
          • Create connector
          • Get connector
          • Search connector
          • Update connector
          • Delete connector
        • Agent APIs
          • Register agent
          • Execute agent
          • Get agent
          • Search agent
          • Delete agent
        • Memory APIs
          • Create or update memory
          • Get memory
          • Search memory
          • Delete memory
          • Create or update message
          • Get message
          • Search message
          • Get message traces
        • Controller APIs
          • Create controller
          • Get controller
          • Delete controller
        • Execute algorithm
        • Tasks APIs
          • Get task
          • Search task
          • Delete task
        • Train and Predict APIs
          • Train and predict
          • Train
          • Predict
        • Profile
        • Stats
    • Automating configurations
      • Workflow steps
      • Workflow tutorial
      • Workflow templates
      • Workflow settings
      • Workflow APIs
        • Create or update a workflow
        • Get a workflow
        • Provision a workflow
        • Get a workflow status
        • Get workflow steps
        • Search for a workflow
        • Search for a workflow state
        • Deprovision a workflow
        • Delete a workflow
    • Monitoring your cluster
      • Job Scheduler
      • Metrics framework
      • Performance Analyzer
        • API
        • Create PerfTop Dashboards
        • Metrics Reference
        • Root Cause Analysis
          • API
          • RCA Reference
          • Hot shard identification
    • Observability
      • Observability security
      • Application analytics
      • Event analytics
      • Log ingestion
      • Metrics analytics
      • Query insights
        • Top N queries
      • Trace Analytics
        • Getting Started
        • OpenSearch Dashboards plugin
        • Analyzing Jaeger trace data
        • Distrbuted tracing
      • Notebooks
      • Operational panels
      • Alerting
        • Monitors
          • Per query and per bucket monitors
          • Per cluster metrics monitors
          • Per document monitors
          • Composite monitors
          • Triggers
          • Actions
        • Management
        • Alerting security
        • API
        • Cron
        • Alerting dashboards and visualizations
      • Anomaly detection
        • Anomaly detection API
        • Settings
        • Anomaly result mapping
        • Anomaly detection security
        • Anomaly detection visualizations and dashboards
      • Notifications
        • API
      • Simple Schema for Observability
      • Cross-cluster search
    • Reporting
      • Reporting using OpenSearch Dashboards
      • Reporting using the CLI
        • Download and install the Reporting CLI tool
        • Create and request visualization reports
        • Schedule reports with the cron utility
        • Schedule reports with AWS Lambda
        • Reporting CLI options
        • Use environment variables with the Reporting CLI
    • Tools
      • OpenSearch CLI
      • OpenSearch Kubernetes Operator
      • Logstash
        • Logstash execution model
        • Common filter plugins
        • Read from OpenSearch
        • Ship events to OpenSearch
        • Advanced configurations
      • Terraform
      • Grafana
    • API reference
      • Analyze API
        • Analysis API Terminology
      • CAT API
        • CAT aliases
        • CAT allocation
        • CAT count
        • CAT field data
        • CAT health
        • CAT indices operation
        • CAT cluster manager
        • CAT nodeattrs
        • CAT nodes
        • CAT pending tasks
        • CAT plugins
        • CAT recovery
        • CAT repositories
        • CAT segment replication
        • CAT segments
        • CAT shards
        • CAT snapshots
        • CAT tasks
        • CAT templates
        • CAT thread pool
      • Cluster APIs
        • Cluster allocation explain
        • Cluster routing and awareness
        • Cluster decommission
        • Cluster health
        • Cluster settings
        • Cluster stats
      • Count
      • Document APIs
        • Index document
        • Get document
        • Update document
        • Delete document
        • Bulk
        • Multi-get document
        • Delete by query
        • Update by query
        • Reindex document
      • Explain
      • Index APIs
        • Alias
        • Clear cache
        • Clone index
        • Close index
        • Create index
        • Create or update mappings
        • Dangling indexes
        • Delete index
        • Force merge
        • Get index
        • Get settings
        • Index exists
        • Open index
        • Refresh index
        • Shrink index
        • Split index
        • Stats
        • Update settings
      • Ingest APIs
      • Multi-search
      • Nodes APIs
        • Nodes info
        • Nodes stats
        • Nodes hot threads
        • Nodes usage
        • Nodes reload secure settings
      • Profile
      • Ranking evaluation
      • Remote cluster information
      • Script APIs
        • Create or Update Stored Script
        • Execute Painless stored script
        • Get Stored Script
        • Delete Script
        • Get Stored Script Contexts
        • Get Script Language
        • Execute Painless script
      • Scroll
      • Search
      • Search templates
      • Snapshot APIs
        • Register Snapshot Repository
        • Get Snapshot Repository
        • Delete Snapshot Repository
        • Verify Snaphot Repository
        • Create Snapshot
        • Get Snapshot
        • Delete Snapshot
        • Get Snapshot Status
        • Restore Snapshot
      • Tasks
      • Supported units
      • Common REST Parameters
      • Popular APIs
    • Troubleshooting
      • Troubleshoot securityadmin.sh
      • Troubleshoot TLS
      • Troubleshoot SAML
      • Troubleshoot OpenID Connect
    • Developer documentation
      • Extensions
    暂无相关搜索结果！

      本文档使用 BookStack 构建

      展开/收起文章目录

      分享，让知识传承更久远

      文章二维码

      手机扫一扫，轻松掌上读

      文档下载

      • 普通下载
      • 下载码下载(免登录无限下载)
      你与大神的距离，只差一个APP
      APP下载
      请下载您需要的格式的文档，随时随地，享受汲取知识的乐趣！
      PDF文档 EPUB文档 MOBI文档
      温馨提示 每天每在网站阅读学习一分钟时长可下载一本电子书，每天连续签到可增加阅读时长
      下载码方式下载：免费、免登录、无限制。 免费获取下载码

      微信小程序阅读

      BookChat 微信小程序阅读
      您与他人的薪资差距，只差一个随时随地学习的小程序

      书签列表

        阅读记录

        阅读进度: 0.00% ( 0/0 ) 重置阅读进度