ListOnlineConfigs - 获取在线表配置的详情

获取在线表配置的详情。

接口说明

方法

GET

URI

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:ListOnlineConfigslist
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

请求语法

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

请求参数

名称类型必填描述示例值
instanceIdstring

实例 id

ha-cn-pl32rf0****
nodeNamestring

节点名称。

ha-cn-pl32rf0****_qrs
domainstring

域名

sz_vpc_domain_1

###请求示例

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

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID。

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

返回结果。

itemobject

配置结果列表

indexNamestring

索引名称

generation
configstring

配置信息

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

返回示例

正确返回 

{

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

      }    

  ]

}

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。