EXexoscale
dbaas

Get a DBaaS OpenSearch service

Changed on

Get a DBaaS OpenSearch service

get/dbaas-opensearch/{name}

Request

Path parameters

namestring required

Response

200

descriptionstring

DbaaS service description

max-index-countinteger nullable

Maximum number of indexes to keep before deleting the oldest one

updated-atstring date-time

Service last update timestamp (ISO 8601)

node-countinteger

Number of service nodes in the active plan

node-cpu-countinteger

Number of CPUs for each node

zonestring

The zone where the service is running

namestring required
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.

typestring required
state'running' | 'rebuilding' | 'rebalancing' | 'poweroff'
ip-filterstring[]

Allowed CIDR address blocks for incoming connections

termination-protectionboolean

Service is protected against termination and powering off

disk-sizeinteger

TODO UNIT disk space for data storage

node-memoryinteger

TODO UNIT of memory for each node

uristring

URI for connecting to the service (may be absent)

uri-paramsobject

service_uri parameterized into key-value pairs

versionstring

OpenSearch version

created-atstring date-time

Service creation timestamp (ISO 8601)

planstring required

Subscription plan

Example response

{
  "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
  }
}

Changes

  • 814bf1ccd925Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property became nullable for the status

  • 37a05010e8b4Revision changes
    • info

      added the required property to the response with the status