dbaas

Create a DBaaS OpenSearch service

Changed on

Create a DBaaS OpenSearch service

post/dbaas-opensearch/{name}

Request

Path parameters

namestring required

Request body

max-index-countinteger nullable

Maximum number of indexes to keep before deleting the oldest one

keep-index-refresh-intervalboolean

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-filterstring[]

Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'

termination-protectionboolean

Service is protected against termination and powering off

fork-from-servicestring
versionstring

OpenSearch major version

recovery-backup-namestring

Name of a backup to recover from for services that support backup names

planstring required

Subscription plan

Example request

{
  "opensearch-settings": {
    "knn_memory_circuit_breaker_enabled": true,
    "http_max_initial_line_length": 4096,
    "enable_security_audit": true,
    "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"
    },
    "action_destructive_requires_name": true,
    "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
    },
    "knn_memory_circuit_breaker_limit": 50,
    "cluster_max_shards_per_node": 1000
  }
}

Response

200

idstring uuid

Operation ID

reason'incorrect' | 'unknown' | 'unavailable' | 'forbidden' | 'busy' | 'fault' | 'partial' | 'not-found' | 'interrupted' | 'unsupported' | 'conflict'

Operation failure reason

messagestring

Operation message

state'failure' | 'pending' | 'success' | 'timeout'

Operation status

Changes

    • info

      the request property // became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property became nullable

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /