ListOnlineConfigs API でオンライン設定を取得 - OpenSearch

操作説明

メソッド

GET

URI

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

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

searchengine:ListOnlineConfigs

list

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	ha-cn-pl32rf0****
nodeName	string	必須	クエリ結果サーチャー (QRS) ワーカーの名前。	ha-cn-pl32rf0****_qrs

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
domain	string	必須	ドメイン名。	sz_vpc_domain_1

### サンプルリクエスト

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

レスポンスフィールド

フィールド	型	説明	例
	object
requestId	string	リクエストの ID。	E45380E8-994A-5402-9806-F114B3295FCF
result	array<object>	リスト。
	object	構成結果のリスト。
indexName	string	インデックス名。	generation
config	string	構成情報。	{\"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}}"
      }    
  ]
}

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。