Search allocators

POST /platform/infrastructure/allocators/_search
Basic auth Api key

Retrieves the information for all the allocators in the platform that match a specified query.

application/json

Body

The optional search request to execute. If not supplied then all allocators are matched

  • from integer(int32)

    Deprecated, use cursor for a more scalable approach to paging.

  • cursor string

    To retrieve the next page of hits, set this to the cursor value of the previous response. When set, all other fields are ignored.

  • size integer(int32)

    The maximum number of search results to return.

  • query object

    The container for all of the allowed Elasticsearch queries. Specify only one property each time.

    Hide query attributes Show query attributes object
    • match object
      Hide match attribute Show match attribute object
      • * object Additional properties

        Consumes and analyzes text, numbers, and dates, then constructs a query.

        Hide * attributes Show * attributes object
        • query string Required

          The text/numeric/date to query for.

        • operator string

          The operator flag can be set to or or and to control the boolean clauses (defaults to or).

        • minimum_should_match integer(int32)

          The minimum number of optional should clauses to match.

        • analyzer string

          The analyzer that will be used to perform the analysis process on the text. Defaults to the analyzer that was used to index the field.

    • match_all object

      A query that matches all documents.

    • match_none object

      A query that doesn't match any documents.

    • term object
      Hide term attribute Show term attribute object
      • * object Additional properties

        A query for documents that contain the specified term in the inverted index.

        Hide * attribute Show * attribute object
        • value string Required

          The exact value to query for.

    • bool object

      A query for documents that match boolean combinations of other queries.

      Hide bool attributes Show bool attributes object
      • must array[object]

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      • should array[object]

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      • must_not array[object]

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      • filter array[object]

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      • minimum_should_match integer(int32)

        The minimum number of optional should clauses to match.

    • query_string object

      A query that uses the strict query string syntax for parsing. Will return an error for invalid syntax.

      Hide query_string attributes Show query_string attributes object
      • query string Required

        The actual query to be parsed.

      • default_field string

        The default field for query terms if no prefix field is specified.

      • analyzer string

        The analyzer used to analyze each term of the query when creating composite queries.

      • default_operator string

        The default operator used if no explicit operator is specified.

      • allow_leading_wildcard boolean

        When set, * or ? are allowed as the first character. Defaults to false.

    • nested object

      A query that matches nested objects.

      Hide nested attributes Show nested attributes object
      • query object Required

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      • path string Required

        The path to the nested object.

      • score_mode string

        Allows to specify how inner children matching affects score of the parent. Refer to the Elasticsearch documentation for details.

        Values are avg, sum, min, max, or none.

    • prefix object
      Hide prefix attribute Show prefix attribute object
      • * object Additional properties

        The query that matches documents with fields that contain terms with a specified, not analyzed, prefix.

        Hide * attributes Show * attributes object
        • value string Required

          The prefix to search for.

        • boost number(float)

          An optional boost value to apply to the query.

    • exists object

      Matches documents that have at least one non-null value in the original field.

      Hide exists attribute Show exists attribute object
      • field string Required

        The field to check for non-null values in.

    • range object
      Hide range attribute Show range attribute object
      • * object Additional properties

        The query that matches documents with fields that contain terms within a specified range.

        Hide * attributes Show * attributes object
        • gt object

          Greater-than

        • gte object

          Greater-than or equal to

        • lt object

          Less-than

        • lte object

          Less-than or equal to.

        • boost number(float)

          An optional boost value to apply to the query.

        • format string

          Formatted dates will be parsed using the format specified on the date field by default, but it can be overridden by passing the format parameter.

        • time_zone string

          Dates can be converted from another timezone to UTC either by specifying the time zone in the date value itself (if the format accepts it), or it can be specified as the time_zone parameter.

    • simple_query_string object

      A query that uses simple query string syntax. Will ignore invalid syntax.

      Hide simple_query_string attributes Show simple_query_string attributes object
      • query string Required

        The query expressed in simple query string syntax.

      • fields array[string]

        Array of fields to search

      • default_operator string

        The boolean operator used to combine the terms of the query. Valid values are OR (default) and AND.

      • analyze_wildcard boolean

        If true, the query attempts to analyze wildcard terms. Defaults to false.

      • analyzer string

        The name of the analyzer to use to convert the query text into tokens.

      • auto_generate_synonyms_phrase_query boolean

        If true, the parse creates a match_phrase uery for each multi-position token. Defaults to true.

      • flags string

        List of enabled operators for the simple query string syntax. Defaults to ALL.

      • fuzzy_max_expansions integer(int32)

        Maximum number of terms to which the query expands for fuzzy matching. Defaults to 50.

      • fuzzy_prefix_length integer(int32)

        Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.

      • fuzzy_transpositions boolean

        If true, edits for fuzzy matching include transpositions of two adjacent characters. Defaults to false.

      • lenient boolean

        If true, format-based errors, such as providing a text value for a numeric field are ignored. Defaults to false.

      • minimum_should_match string

        Minimum number of clauses that must match for a document to be returned.

      • quote_field_suffix string

        Suffix appended to quoted text in the query string.

  • sort array[object]

    An array of fields to sort the search results by. Defaults to query rank and last modified date descending.

Responses

  • 200 application/json

    An overview of allocators that matched the given search query

    Hide response attribute Show response attribute object
    • zones array[object] Required

      The allocators for the specified zone.

      Hide zones attributes Show zones attributes object
      • zone_id string Required

        Identifier of the zone

      • allocators array[object] Required

        The overview information for the allocator.

        Hide allocators attributes Show allocators attributes object
        • status object Required

          The health status of the allocator.

          Hide status attributes Show status attributes object
          • connected boolean Required

            Whether the allocator is connected

          • healthy boolean Required

            Whether the allocator is healthy, meaning it is either connected or has no instances

          • health_checks object

            The checks performed to determine if an allocator is healthy or not.

            Hide health_checks attributes Show health_checks attributes object
            • is_docker_healthy boolean Required

              Check performed by the allocator to figure out if docker is healthy

            • is_connected_to_zk boolean Required

              Whether the allocator is connected to zk or not

            • has_instances boolean Required

              Whether the allocator has allocated instances

          • maintenance_mode boolean Required

            Whether the allocator is in maintenance mode (meaning that new workload won't be assigned to it)

          • maintenance_mode_timestamp string(date-time)

            Timestamp when allocator last entered or exited maintenance mode

        • allocator_id string Required

          Identifier for this allocator

        • zone_id string Required

          Identifier of the zone

        • host_ip string Required

          Host IP of this allocator

        • public_hostname string Required

          Public hostname of this allocator

        • capacity object Required

          The total and used capacity of the allocator.

          Hide capacity attributes Show capacity attributes object
          • memory object Required

            The available and used memory of the allocator.

            Hide memory attributes Show memory attributes object
            • total integer(int32) Required

              Total memory in MB capacity installed on this allocator

            • used integer(int32) Required

              Used memory in MB used by instances assigned to this allocator

          • storage object Required

            The storage capacity of the allocator.

            Hide storage attribute Show storage attribute object
            • total integer(int64) Required

              Total storage in MiB capacity installed on this allocator

          • available_cpus integer(int32)

            Total number of CPUs available on this allocator

          • additional_master_bonus number(float)

            Additional bonus CPU shares available to Elasticsearch master instances

        • settings object Required

          The settings for the allocator.

          Hide settings attribute Show settings attribute object
          • capacity integer(int32)

            A memory capacity (in MB) that overrides the capacity defined during installation - requires separate restart of Allocator services on each host to take full effect.

        • instances array[object] Required

          The status of the allocated Kibana instance or APM Server.

          Hide instances attributes Show instances attributes object
          • cluster_type string Required

            Type of instance that is running

            Values are elasticsearch, kibana, apm, integrations_server, appsearch, or enterprise_search.

          • cluster_id string Required

            Identifier for the cluster this instance belongs

          • cluster_name string

            Name of cluster this instance belongs, if available

          • instance_name string Required

            Instance ID of the instance

          • node_memory integer(int32) Required

            Memory assigned to this instance

          • healthy boolean

            Indicates whether the instance is healthy

          • cluster_healthy boolean

            Indicates whether the cluster the instance belongs to is healthy

          • instance_configuration_id string

            The instance configuration id of this instance

          • moving boolean

            Indicates whether the instance is vacating away from this allocator. Note that this is currently not populated when returned from the search endpoint.

          • plans_info object

            The plan information for the Elasticsearch cluster associated with the Kibana instance or APM Server.

            Hide plans_info attributes Show plans_info attributes object
            • pending boolean Required

              Whether or not there is a pending plan.

            • version string

              The version of the current plan, falling back to that of the pending plan if it exists.

            • zone_count integer(int32)

              The number of zones in the current plan, falling back to that of the pending plan if it exists.

          • deployment_id string

            The id of the deployment this cluster belongs to.

        • metadata array[object] Required

          Arbitrary metadata associated with this allocator

          The key-value pair.

          Hide metadata attributes Show metadata attributes object
          • key string Required

            The metadata field name

          • value string Required

            The metadata value

        • build_info object

          Information about the build that is running on the allocator.

          Hide build_info attributes Show build_info attributes object
          • commit_hash string

            Git commit hash

          • version string

            Version of the artifact

        • features array[string] Required

          List of features associated with this allocator. Note this is only present for backwards compatibility purposes and is scheduled for removal in the next major version release.

        • external_links array[object] Required

          External resources related to this allocator.

          Hide external_links attributes Show external_links attributes object
          • id string Required

            Identifier of the external link

          • label string Required

            Human-readable description of the external link

          • uri string

            hyperlink to an external resource

        • region string

          The region that this allocator belongs to. Only populated in SaaS or federated ECE.
POST /platform/infrastructure/allocators/_search 
curl \
 --request POST 'https://{{hostname}}/api/v1/platform/infrastructure/allocators/_search' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{"from":42,"cursor":"string","size":42,"query":{"match":{"additionalProperty1":{"query":"string","operator":"string","minimum_should_match":42,"analyzer":"string"},"additionalProperty2":{"query":"string","operator":"string","minimum_should_match":42,"analyzer":"string"}},"match_all":{},"match_none":{},"term":{"additionalProperty1":{"value":"string"},"additionalProperty2":{"value":"string"}},"bool":{"must":[{}],"should":[{}],"must_not":[{}],"filter":[{}],"minimum_should_match":42},"query_string":{"query":"string","default_field":"string","analyzer":"string","default_operator":"string","allow_leading_wildcard":true},"nested":{"query":{},"path":"string","score_mode":"avg"},"prefix":{"additionalProperty1":{"value":"string","boost":42.0},"additionalProperty2":{"value":"string","boost":42.0}},"exists":{"field":"string"},"range":{"additionalProperty1":{"gt":{},"gte":{},"lt":{},"lte":{},"boost":42.0,"format":"string","time_zone":"string"},"additionalProperty2":{"gt":{},"gte":{},"lt":{},"lte":{},"boost":42.0,"format":"string","time_zone":"string"}},"simple_query_string":{"query":"string","fields":["string"],"default_operator":"string","analyze_wildcard":true,"analyzer":"string","auto_generate_synonyms_phrase_query":true,"flags":"string","fuzzy_max_expansions":42,"fuzzy_prefix_length":42,"fuzzy_transpositions":true,"lenient":true,"minimum_should_match":"string","quote_field_suffix":"string"}},"sort":[{}]}'