Path parameters
-
name
string Required Minimum length is
0
, maximum length is63
.
Body
Required
-
max-index-count
integer(int64) Maximum number of indexes to keep before deleting the oldest one
Minimum value is
0
. -
keep-index-refresh-interval
boolean Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.
-
ip-filter
array[string] Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
-
termination-protection
boolean Service is protected against termination and powering off
-
index-patterns
array[object] Allows you to create glob style patterns and set a max number of indexes matching this pattern you want to keep. Creating indexes exceeding this value will cause the oldest one to get deleted. You could for example create a pattern looking like 'logs.?' and then create index logs.1, logs.2 etc, it will delete logs.1 once you create logs.6. Do note 'logs.?' does not apply to logs.10. Note: Setting max_index_count to 0 will do nothing and the pattern gets ignored.
-
maintenance
object Automatic maintenance settings
-
index-template
object Template settings for all new indexes
-
opensearch-settings
object Additional properties are NOT allowed.
-
version
string Version
-
plan
string Subscription plan
Minimum length is
1
, maximum length is128
. -
opensearch-dashboards
object OpenSearch Dashboards settings
curl \
--request PUT https://api-ch-gva-2.exoscale.com/v2/dbaas-opensearch/{name} \
--header "Content-Type: application/json" \
--data '{"max-index-count":42,"keep-index-refresh-interval":true,"ip-filter":["string"],"termination-protection":true,"index-patterns":[{"max-index-count":42,"sorting-algorithm":"alphabetical","pattern":"string"}],"maintenance":{"dow":"saturday","time":"string"},"index-template":{"mapping-nested-objects-limit":42,"number-of-replicas":42,"number-of-shards":42},"opensearch-settings":{"thread_pool_search_throttled_size":42,"thread_pool_analyze_size":42,"thread_pool_get_size":42,"thread_pool_get_queue_size":42,"indices_memory_max_index_buffer_size":42,"indices_recovery_max_concurrent_file_chunks":42,"indices_queries_cache_size":42,"search_backpressure":{"mode":"monitor_only","node_duress":{"cpu_threshold":42.0,"heap_threshold":42.0,"num_successive_breaches":42},"search_shard_task":{"total_heap_percent_threshold":42.0,"elapsed_time_millis_threshold":42,"cancellation_rate":42.0,"heap_variance":42.0,"heap_moving_average_window_size":42,"cancellation_ratio":42.0,"heap_percent_threshold":42.0,"cpu_time_millis_threshold":42,"cancellation_burst":42.0},"search_task":{"total_heap_percent_threshold":42.0,"elapsed_time_millis_threshold":42,"cancellation_rate":42.0,"heap_variance":42.0,"heap_moving_average_window_size":42,"cancellation_ratio":42.0,"heap_percent_threshold":42.0,"cpu_time_millis_threshold":42,"cancellation_burst":42.0}},"shard_indexing_pressure":{"primary_parameter":{"shard":{"min_limit":42.0},"node":{"soft_limit":42.0}},"operating_factor":{"upper":42.0,"optimal":42.0,"lower":42.0},"enforced":true,"enabled":true},"knn_memory_circuit_breaker_enabled":true,"thread_pool_search_size":42,"indices_memory_min_index_buffer_size":42,"indices_recovery_max_bytes_per_sec":42,"http_max_initial_line_length":4096,"enable_security_audit":true,"thread_pool_write_queue_size":42,"script_max_compilations_rate":"75/5m","search_max_buckets":10000,"reindex_remote_whitelist":["anotherservice.aivencloud.com:12398"],"override_main_response_version":true,"http_max_header_size":8192,"email-sender":{"email_sender_name":"alert-sender","email_sender_password":"very-secure-mail-password","email_sender_username":"jane@example.com"},"indices_fielddata_cache_size":42,"action_destructive_requires_name":true,"plugins_alerting_filter_by_backend_roles":false,"indices_memory_index_buffer_size":42,"thread_pool_force_merge_size":42,"auth_failure_listeners":{"internal_authentication_backend_limiting":{"allowed_tries":10,"authentication_backend":"internal","block_expiry_seconds":600,"max_blocked_clients":100000,"max_tracked_clients":100000,"time_window_seconds":3600,"type":"username"},"ip_rate_limiting":{"allowed_tries":10,"block_expiry_seconds":600,"max_blocked_clients":100000,"max_tracked_clients":100000,"time_window_seconds":3600,"type":"ip"}},"ism-history":{"ism_enabled":true,"ism_history_enabled":true,"ism_history_max_age":24,"ism_history_max_docs":2500000,"ism_history_rollover_check_period":8,"ism_history_rollover_retention_period":30},"cluster_routing_allocation_node_concurrent_recoveries":42,"thread_pool_analyze_queue_size":42,"action_auto_create_index_enabled":false,"http_max_content_length":42,"thread_pool_write_size":42,"thread_pool_search_queue_size":42,"knn_memory_circuit_breaker_limit":50,"indices_query_bool_max_clause_count":42,"thread_pool_search_throttled_queue_size":42,"cluster_max_shards_per_node":1000},"version":"string","plan":"string","opensearch-dashboards":{"opensearch-request-timeout":42,"enabled":true,"max-old-space-size":42}}'
{
"max-index-count": 42,
"keep-index-refresh-interval": true,
"ip-filter": [
"string"
],
"termination-protection": true,
"index-patterns": [
{
"max-index-count": 42,
"sorting-algorithm": "alphabetical",
"pattern": "string"
}
],
"maintenance": {
"dow": "saturday",
"time": "string"
},
"index-template": {
"mapping-nested-objects-limit": 42,
"number-of-replicas": 42,
"number-of-shards": 42
},
"opensearch-settings": {
"thread_pool_search_throttled_size": 42,
"thread_pool_analyze_size": 42,
"thread_pool_get_size": 42,
"thread_pool_get_queue_size": 42,
"indices_memory_max_index_buffer_size": 42,
"indices_recovery_max_concurrent_file_chunks": 42,
"indices_queries_cache_size": 42,
"search_backpressure": {
"mode": "monitor_only",
"node_duress": {
"cpu_threshold": 42.0,
"heap_threshold": 42.0,
"num_successive_breaches": 42
},
"search_shard_task": {
"total_heap_percent_threshold": 42.0,
"elapsed_time_millis_threshold": 42,
"cancellation_rate": 42.0,
"heap_variance": 42.0,
"heap_moving_average_window_size": 42,
"cancellation_ratio": 42.0,
"heap_percent_threshold": 42.0,
"cpu_time_millis_threshold": 42,
"cancellation_burst": 42.0
},
"search_task": {
"total_heap_percent_threshold": 42.0,
"elapsed_time_millis_threshold": 42,
"cancellation_rate": 42.0,
"heap_variance": 42.0,
"heap_moving_average_window_size": 42,
"cancellation_ratio": 42.0,
"heap_percent_threshold": 42.0,
"cpu_time_millis_threshold": 42,
"cancellation_burst": 42.0
}
},
"shard_indexing_pressure": {
"primary_parameter": {
"shard": {
"min_limit": 42.0
},
"node": {
"soft_limit": 42.0
}
},
"operating_factor": {
"upper": 42.0,
"optimal": 42.0,
"lower": 42.0
},
"enforced": true,
"enabled": true
},
"knn_memory_circuit_breaker_enabled": true,
"thread_pool_search_size": 42,
"indices_memory_min_index_buffer_size": 42,
"indices_recovery_max_bytes_per_sec": 42,
"http_max_initial_line_length": 4096,
"enable_security_audit": true,
"thread_pool_write_queue_size": 42,
"script_max_compilations_rate": "75/5m",
"search_max_buckets": 10000,
"reindex_remote_whitelist": [
"anotherservice.aivencloud.com:12398"
],
"override_main_response_version": true,
"http_max_header_size": 8192,
"email-sender": {
"email_sender_name": "alert-sender",
"email_sender_password": "very-secure-mail-password",
"email_sender_username": "jane@example.com"
},
"indices_fielddata_cache_size": 42,
"action_destructive_requires_name": true,
"plugins_alerting_filter_by_backend_roles": false,
"indices_memory_index_buffer_size": 42,
"thread_pool_force_merge_size": 42,
"auth_failure_listeners": {
"internal_authentication_backend_limiting": {
"allowed_tries": 10,
"authentication_backend": "internal",
"block_expiry_seconds": 600,
"max_blocked_clients": 100000,
"max_tracked_clients": 100000,
"time_window_seconds": 3600,
"type": "username"
},
"ip_rate_limiting": {
"allowed_tries": 10,
"block_expiry_seconds": 600,
"max_blocked_clients": 100000,
"max_tracked_clients": 100000,
"time_window_seconds": 3600,
"type": "ip"
}
},
"ism-history": {
"ism_enabled": true,
"ism_history_enabled": true,
"ism_history_max_age": 24,
"ism_history_max_docs": 2500000,
"ism_history_rollover_check_period": 8,
"ism_history_rollover_retention_period": 30
},
"cluster_routing_allocation_node_concurrent_recoveries": 42,
"thread_pool_analyze_queue_size": 42,
"action_auto_create_index_enabled": false,
"http_max_content_length": 42,
"thread_pool_write_size": 42,
"thread_pool_search_queue_size": 42,
"knn_memory_circuit_breaker_limit": 50,
"indices_query_bool_max_clause_count": 42,
"thread_pool_search_throttled_queue_size": 42,
"cluster_max_shards_per_node": 1000
},
"version": "string",
"plan": "string",
"opensearch-dashboards": {
"opensearch-request-timeout": 42,
"enabled": true,
"max-old-space-size": 42
}
}
{
"id": "string",
"reason": "incorrect",
"reference": {
"id": "string",
"link": "string",
"command": "string"
},
"message": "string",
"state": "failure"
}