All Products
Search
Document Center

OpenSearch:ListOnlineConfigs

Last Updated:Jul 16, 2024

Queries the details of an online configuration.

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs?domain={domain}

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-0ju2s170b03
nodeNamestringYes

The name of the Query Result Searcher (QRS) worker.

ha-cn-2r42ostoc01_qrs
domainstringYes

The name of the domain

sz_vpc_domain_1

### Sample requests

GET  /openapi/ha3/instances/ha-test1/node/ihome_searcher/online-configs?domain=pre_ea120

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

id of request

E45380E8-994A-5402-9806-F114B3295FCF
resultarray<object>

List

object

The list of configuration results

indexNamestring

The name of the index

generation
configstring

The configuration information

{\"specItems\":[{\"specKey\":\"YQ_KEYWORD_NUMBER_PLUS\",\"value\":\"1\"}]}

Sample responses

Success responses 

{

  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",

  "result": [

      {

          "indexName": "nm_algo_dense_weights",

          "config": "{\"realtime\":false,\"cluster_config\":{\"table_name\":\"nm_algo_dense_weights\"},\"online_index_config\":{\"online_keep_version_count\":3,\"build_config\":{\"build_total_memory\":1024},\"max_realtime_memory_use\":1024,\"load_config\":[{\"file_patterns\":[\".*\"],\"load_strategy\":\"mmap\",\"load_strategy_param\":{\"slice\":409600,\"lock\":true,\"interval\":2}},{\"file_patterns\":[\".*\"],\"load_strategy\":\"mmap\",\"load_strategy_param\":{\"slice\":409600,\"lock\":true,\"interval\":2}},{\"file_patterns\":[\"/summary/data\"],\"load_strategy\":\"cache\",\"load_strategy_param\":{\"direct_io\":true,\"cache_size\":512}},{\"warmup_strategy\":\"none\",\"file_patterns\":[\".*\"],\"load_strategy\":\"mmap\",\"load_strategy_param\":{\"lock\":false}}]},\"build_option_config\":{\"async_queue_size\":1000,\"max_recover_time\":10,\"async_build\":true}}"

      },

      {

          "indexName": "search4_mj_mos_item_index",

          "config": "{\"realtime\":true,\"cluster_config\":{\"table_name\":\"search4_mj_mos_item_index\"},\"online_index_config\":{\"online_keep_version_count\":3,\"build_config\":{\"build_total_memory\":4096},\"max_realtime_memory_use\":8192,\"load_config\":[{\"warmup_strategy\":\"sequential\",\"file_patterns\":[\"_INDEX_\"],\"load_strategy\":\"mmap\",\"name\":\"_INDEX_\",\"load_strategy_param\":{\"lock\":true}},{\"warmup_strategy\":\"none\",\"file_patterns\":[\"_SUMMARY_\"],\"load_strategy\":\"mmap\",\"name\":\"_SUMMARY_\",\"load_strategy_param\":{\"lock\":true}},{\"warmup_strategy\":\"sequential\",\"file_patterns\":[\"_ATTRIBUTE_\"],\"load_strategy\":\"mmap\",\"name\":\"_ATTRIBUTE_\",\"load_strategy_param\":{\"lock\":true}}],\"speedup_primary_key_reader\":true},\"build_option_config\":{\"async_queue_size\":10000,\"max_recover_time\":10,\"async_build\":true}}"

      },

      {

          "indexName": "nm_algo_search_retrieval_item_index",

          "config": "{\"realtime\":true,\"cluster_config\":{\"table_name\":\"nm_algo_search_retrieval_item_index\"},\"online_index_config\":{\"online_keep_version_count\":3,\"build_config\":{\"build_total_memory\":4096},\"max_realtime_memory_use\":8192,\"load_config\":[{\"warmup_strategy\":\"sequential\",\"file_patterns\":[\"_INDEX_\"],\"load_strategy\":\"mmap\",\"name\":\"_INDEX_\",\"load_strategy_param\":{\"lock\":true}},{\"warmup_strategy\":\"none\",\"file_patterns\":[\"_SUMMARY_\"],\"load_strategy\":\"mmap\",\"name\":\"_SUMMARY_\",\"load_strategy_param\":{\"lock\":true}},{\"warmup_strategy\":\"sequential\",\"file_patterns\":[\"_ATTRIBUTE_\"],\"load_strategy\":\"mmap\",\"name\":\"_ATTRIBUTE_\",\"load_strategy_param\":{\"lock\":true}}],\"speedup_primary_key_reader\":true},\"build_option_config\":{\"async_queue_size\":10000,\"max_recover_time\":10,\"async_build\":true}}"

      }    

  ]

}

Examples

Sample success responses

JSONformat

{
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": [
    {
      "indexName": "generation",
      "config": "{\\\"specItems\\\":[{\\\"specKey\\\":\\\"YQ_KEYWORD_NUMBER_PLUS\\\",\\\"value\\\":\\\"1\\\"}]}"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.