All Products
Search
Document Center

OpenSearch:ListOnlineConfigs

Last Updated:Oct 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
searchengine:ListOnlineConfigslist
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request syntax

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

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

itemobject

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.