すべてのプロダクト
Search
ドキュメントセンター

Elasticsearch:よく使用されるパラメータ

最終更新日:Mar 17, 2025

ClientNodeConfiguration

クライアントノードの構成。

パラメータ

タイプ

説明

diskType

String

cloud_efficiency

コーディネータノードのストレージタイプ。有効値: cloud_efficiency (Ultra ディスク)。

amount

Long

3

コーディネータノードの数。

spec

String

elasticsearch.sn2ne.large

調整されたノードの仕様。詳細については、「製品仕様」をご参照ください。

disk

Long

20

コーディネータノードのストレージ容量。単位: GB。

DictInfo

辞書設定情報。

パラメータ

タイプ

説明

type

String

ALI_WS

辞書ファイルのタイプ。有効値:

  • STOP: ストップワードリスト
  • MAIN: メイン辞書
  • SYNONYMS: 類義語辞書
  • ALI_WS: Alibaba Cloud 辞書

sourceType

String

OSS

辞書ファイルのソースタイプ。有効値:

  • OSS: Object Storage Service (OSS)。関連する OSS バケットの ACL がパブリック読み取りであることを確認する必要があります。
  • ORIGIN: オープンソース Elasticsearch
  • UPLOAD: アップロードされたファイル

fileSize

Long

2782602

辞書ファイルのサイズ。単位: バイト。

name

String

aliws_ext_dict.txt

辞書ファイルの名前。このアノテーションを設定する前に、次の要件に注意してください。

  • メイン辞書/ストップワード: 1 行に 1 ワード、UTF-8 エンコードの DIC ファイルとして保存されます。ファイル名には、文字、数字、およびアンダースコアを含めることができ、最大 30 文字まで使用できます。同じ名前のファイルをアップロードすることはできません。
  • 類義語辞書: 各行には 1 つの類義語式のみが含まれ、UTF-8 エンコードの TXT ファイルとして保存されます。
  • Ali 辞書: ファイル名は aliws_ext_dict.txt である必要があります。ファイル形式は UTF-8 形式である必要があります。ファイルの内容は 1 行に 1 ワードで、前後に空白文字があってはなりません。UNIX または Linux の改行を使用する必要があります。つまり、各行の末尾は \n です。辞書ファイルが Windows で生成された場合は、アップロードする前に dos2unix ツールを使用してファイルを変換する必要があります。

ElasticDataNodeConfiguration

Elastic データノードの構成。

パラメータ

タイプ

説明

diskType

String

cloud_ssd

Elastic ノードのストレージタイプ。サポートされているストレージタイプ:

  • cloud_ssd: SSD
  • cloud_essd: 拡張 SSD (ESSD)
  • cloud_efficiency: Ultra ディスク。

diskEncryption

Boolean

false

Elastic ノードのディスク暗号化を有効にするかどうか:

  • true: 機能を有効にします。
  • false: 機能を無効にします。

amount

Long

3

Elastic ノードの数。

spec

String

elasticsearch.sn2ne.large

Elastic ノードの仕様。詳細については、「製品仕様」をご参照ください。

disk

Long

20

Elastic ノードのストレージ容量。単位: GB。

performanceLevel

String

PL1

ディスクのパフォーマンスレベル (PL)。このパラメータは、ディスクのカテゴリが ESSD の場合にのみ有効です。このプロパティは、Elastic ノードのディスクタイプが拡張 SSD に設定されている場合に必須です。サポートされているもの: PL1、PL2、および PL3。

Elasticsearch

Elasticsearch インスタンスの設定情報。

パラメータ

タイプ

説明

masterConfiguration

MasterNodeConfiguration

専用マスターノードの構成。

resourceGroupId

String

rg-aekzvowej3i****

インスタンスが属するリソースグループの ID。

elasticDataNodeConfiguration

ElasticDataNodeConfiguration

Elastic ノードの構成。

dedicateMaster

Boolean

false

古い専用マスターノードを含めるかどうか (廃止)。

createdAt

String

2018-07-13T03:58:07.253Z

インスタンスが作成された時刻。

ikHotDicts

DictInfo の配列

IK ホットワード辞書の構成。

port

Long

9200

インスタンスのプライベートポート番号。

kibanaPrivateIPWhitelist

String の配列

["192.168.XX.XX"]

Kibana のホワイトリストに含まれるプライベート IP アドレスのリスト。

esVersion

String

6.3.2_with_X-Pack

インスタンスのバージョン。

kibanaConfiguration

KibanaNodeConfiguration

Kibana ノードの構成。

dataNode

Boolean

true

インスタンスにデータノードが含まれているかどうかを示します。

  • true
  • false

serviceVpc

Boolean

true

インスタンスが Elasticsearch Service VPC 内にあるかどうかを示します。

  • true: 内
  • false: 外

tags

Tag の配列

インスタンスのタグ。

haveKibana

Boolean

true

インスタンスに Kibana ノードが含まれているかどうか:

  • true
  • false

dictList

DictInfo の配列

IK 辞書の構成。

extendConfigs

Object の配列

[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]

インスタンスの追加構成。

status

String

active

インスタンスのステータス。有効値:

  • active: クラスタは正常です。
  • activating: クラスタはアクティブ化されています。
  • Inactive: クラスタは凍結されています。
  • invalid: クラスタは無効です。

instanceId

String

es-cn-3h4k3axh33th9****

インスタンス ID。

zoneInfos

ZoneInfo の配列

インスタンスが存在するゾーン。

kibanaProtocol

String

HTTPS

Kibana アクセスプロトコル。 HTTP と HTTPS がサポートされています。

enableKibanaPrivateNetwork

Boolean

false

Kibana のプライベートネットワークアクセスを有効にするかどうか:

  • true: 機能を有効にします。
  • false: 機能を無効にします。

kibanaDomain

String

es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com

クラスタの Kibana コンソールのパブリックエンドポイント。

nodeSpec

NodeSpec

データノードの構成。

warmNode

Boolean

false

コールドデータノードを有効にするかどうか:

  • true: 機能を有効にします。
  • false: 機能を無効にします。

warmNodeConfiguration

WarmNodeConfiguration

ウォームノードの構成。

domain

String

es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com

Elasticsearch インスタンスのプライベートエンドポイント。

haveClientNode

Boolean

false

コーディネータノードを有効にするかどうか:

  • true: 機能を有効にします。
  • false: 機能を無効にします。

clientNodeConfiguration

ClientNodeConfiguration

クライアントノードの構成。

description

String

es-cn-abc

インスタンス名。

endTime

Long

5

インスタンスの有効期限が切れる時刻。単位: 年。従量課金インスタンスはデフォルトで 100 年です。

enablePublic

Boolean

true

インスタンスのパブリックエンドポイントを有効にするかどうか:

  • true: 機能を有効にします。
  • false: 機能を無効にします。

aliwsDicts

DictInfo の配列

Aliws 辞書構成。

advancedDedicateMaster

Boolean

true

新バージョンの専用マスターノードを有効にするかどうか:

  • true: 機能を有効にします。
  • false: 機能を無効にします。

paymentType

String

prepaid

インスタンスの課金方法。サポートされている値:

  • prepaid: サブスクリプション
  • postpaid: 従量課金

readWritePolicy

ReadWritePolicy

インスタンスの高可用性機能に関する構成情報。

protocol

String

HTTP

インスタンスのアクセスプロトコル。有効値: HTTP および HTTPS。

publicIpWhitelist

String の配列

["0.0.0.0/0"]

インスタンスのパブリックエンドポイントホワイトリスト。

kibanaPort

Long

5601

Kibana のパブリックネットワークポート番号。

enableKibanaPublicNetwork

Boolean

true

Kibana のインターネットアクセスを有効にするかどうか:

  • true: 機能を有効にします。
  • false: 機能を無効にします。

networkConfig

NetworkConfig

インスタンスのネットワーク構成。

productType

String

generalBusiness

インスタンスのバージョンタイプ。有効値:

  • logEnhancement: ログ拡張版
  • generalBusiness: 一般ビジネス版

advancedSetting

Object

詳細設定。

gcName

String

CMS

ガベージコレクタ (GC) の名前。 CMS と G1 をサポートしています。

nodeAmount

Long

2

データノードの数。

updatedAt

String

2018-07-13T03:58:07.253Z

インスタンスが最後に更新された時刻。

esConfig

Map

クラスタの YML ファイル構成。

esIPWhitelist

String の配列

["0.0.0.0/0"]

プライベートネットワークアクセスホワイトリストのリスト。

kibanaIPWhitelist

String の配列

["0.0.0.0/0"]

Kibana パブリックエンドポイントアクセスホワイトリスト。

privateNetworkIpWhiteList

String の配列

["0.0.0.0/0"]

インスタンスの IP アドレスホワイトリスト。

synonymsDicts

DictInfo の配列

インスタンスの類義語辞書構成。

haveElasticDataNode

Boolean

false

Elastic データノードを有効にするかどうか:

  • true: 機能を有効にします。
  • false: 機能を無効にします。

zoneCount

Long

1

Elasticsearch クラスタをデプロイするゾーンの数。

kibanaPrivateDomain

String

es-cn-tl329rbpc0001****-kibana.internal.elasticsearch.aliyuncs.com

Kibana のプライベートエンドポイント。

kibanaPrivatePort

Long

5601

Kibana のプライベートポート番号。

publicDomain

String

es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com

インターネット経由で Elasticsearch クラスタにアクセスするために使用されるアドレス。

publicPort

Long

9200

Elasticsearch インスタンスのパブリックポート番号。

KibanaNodeConfiguration

Kibana ノードの構成。

パラメータ

タイプ

説明

amount

Long

2

Kibana ノードの数。1 つの Kibana ノードのみがサポートされています。

spec

String

elasticsearch.sn2ne.large

Kibana ノードの仕様。詳細については、「製品仕様」をご参照ください。

disk

Long

20

Kibana ノードのストレージ容量。単位: GB。

Logstash

パラメータオブジェクト。

パラメータ

タイプ

説明

endpointList

Array

ノード情報。

host

String

172.16.xx.xx

ノードの IP アドレス。

port

Long

9200

ノードへのアクセスに使用されるポート番号。

zoneId

String

cn-hangzhou-i

ノードのゾーン ID。

status

String

NORMAL

ゾーンのステータス。有効値:

  • ISOLATION: 無効
  • NORMAL: 正常

description

String

ls-cn-abc

インスタンス名。

resourceGroupId

String

rg-acfm2h5vbzd****

ECS インスタンスが属するリソースグループの ID。

endTime

Long

4749897600000

インスタンスの最終有効期限。

instanceId

String

ls-cn-n6w1o5jq****

インスタンス ID。

config

Map

ECS インスタンスの設定。

createdAt

String

2018-07-13T03:58:07.253Z

インスタンスが作成された時刻。

networkConfig

Object

ネットワーク構成。

type

String

vpc

ネットワークタイプ。Virtual Private Cloud (VPC) のみがサポートされています。

vpcId

String

vpc-abc

VPC ID。

vsArea

String

cn-hangzhou-*

NLB インスタンスのゾーンを選択します。

vswitchId

String

vsw-def

vSwitch ID。

zoneInfos

Array

ゾーン ID。

status

String

NORMAL

ゾーンのステータス。有効値:

  • ISOLATION: 無効
  • NORMAL: 正常

zoneId

String

cn-hangzhou-i

ゾーン ID。

nodeAmount

Long

2

クラスタ内のノードの数。

updatedAt

String

2018-07-18T10:10:04.484Z

インスタンスが最後に更新された時刻。

version

String

6.7.0_with_X-Pack

インスタンスのバージョン。有効値:

  • 6.7.0_with_X-Pack
  • 7.4.0_with_X-Pack

dataNode

Boolean

true

データノードを有効にするかどうか。このパラメータは true に設定する必要があります。

nodeSpec

Object

データノードの構成。

disk

Long

50

コアノードのディスクサイズ。

diskType

String

cloud_ssd

ノードのディスクカテゴリ。

spec

String

logstash.n4.small

ノードの仕様。

paymentType

String

postpaid

クラスタの課金方法。有効値:

  • prepaid: サブスクリプション
  • postpaid: 従量課金

protocol

String

HTTP

インスタンスのアクセスプロトコル。

tags

Array

インスタンスのタグ。

tagKey

String

env

タグのキー。

tagValue

String

dev

タグの値。

zoneCount

Long

1

Elasticsearch クラスタをデプロイするゾーンの数。

MasterNodeConfiguration

専用マスターノードの構成。

パラメータ

タイプ

説明

amount

Long

3

専用マスターノードの数。

spec

String

elasticsearch.sn2ne.large

専用マスターノードの仕様。詳細については、「製品仕様」をご参照ください。

disk

Long

20

専用マスターノードのストレージ容量。単位: GB。

diskType

String

cloud_essd

専用マスターノードのストレージタイプ。サポートされているもの:

  • cloud_ssd: 標準 SSD。
  • cloud_essd (デフォルト): 拡張 SSD

NetworkConfig

ネットワーク構成。

パラメータ

タイプ

説明

type

String

vpc

ネットワークタイプ。Virtual Private Cloud のみがサポートされています。

vpcId

String

vpc-bp1xk0naij7jx4ph1****

VPC ID。

whiteIpGroupList

WhiteIpGroup の配列

IP アドレスホワイトリストの構成。インスタンスの作成時に IP アドレスホワイトリストを指定することはできません。異なるロールのホワイトリストを API を使用して個別に設定する必要があります。

vswitchId

String

vsw-bp1ogpdintii5qvyx****

vSwitch ID。

vsArea

String

cn-hangzhou-e

ネットワークが属するゾーンの ID。

NodeInfo

ノード情報。

パラメータ

タイプ

説明

host

String

172.16.xx.xx

ノードの IP アドレス。

hostName

String

es-cn-tl32vdghe0005cd99-data-b-2

ノードの名前。ACK に基づいてデプロイされたバージョン 7.16 のインスタンスのみがサポートされています。

port

Long

9200

ノードのポート番号。

zoneId

String

cn-hangzhou-b

ノードが存在するゾーンの ID。

NodeSpec

データノードの構成。

パラメータ

タイプ

説明

diskType

String

cloud_ssd

データノードのストレージタイプ。次のタイプのデータノードを使用できます。

  • cloud_ssd: SSD
  • cloud_essd: 拡張 SSD (ESSD)
  • cloud_efficiency: Ultra ディスク。

spec

String

elasticsearch.sn2ne.large

検索ワーカーの仕様。詳細については、「製品仕様」をご参照ください。

説明

createInstance を使用して、中国 (北京)、中国 (上海)、中国 (杭州)、または中国 (深圳) リージョンに新世代のディスクタイプデータノードのクラウドネイティブインスタンスを作成する場合は、インスタンスファミリと接尾辞 .new を指定する必要があります。たとえば、Elasticsearch.sn1ne.large.new などです。

disk

Integer

20

データノードのストレージ容量。単位: GB。

diskEncryption

Boolean

false

データノードのディスク暗号化を有効にするかどうか:

  • true: 機能を有効にします。
  • false: 機能を無効にします。

performanceLevel

String

PL1

ディスクのパフォーマンスレベル (PL)。このパラメータは、ディスクのカテゴリが ESSD の場合にのみ有効です。このパラメータは、データノードのディスクタイプが拡張 SSD の場合に必須です。サポートされているもの: PL1、PL2、および PL3。

PaymentInfo

クラスタの課金詳細。

パラメータ

タイプ

説明

duration

Long

1

インスタンスが購入された時刻。このパラメータは必須です。月次および年次購入がサポートされています。

pricingCycle

String

Month

サブスクリプション単位、必須。オプション値:

  • Year
  • Month

isAutoRenew

Boolean

true

自動更新設定を有効にするかどうかを示します。有効値:

  • true
  • false: 機能を無効にします。これはデフォルト値です。

autoRenewDuration

Long

3

自動更新期間。単位: 月。パラメータが true に設定されている場合は、isAutoRenew が必須です。パラメータ値の範囲は、購入ページと同じです。

ReadWritePolicy

高可用性機能のパラメータ構成。

パラメータ

タイプ

説明

writeHa

Boolean

true

書き込み高可用性機能が有効になっているかどうかを示します。

  • true: 機能を有効にします。
  • false: 機能を無効にします。

autoGeneratePk

Boolean

true

プライマリキーが存在しない場合に、ドキュメントハッシュ値プライマリキーを自動的に生成するかどうか:

  • true: プライマリキーを自動的に生成します。これはデフォルト値です。
  • false: プライマリキーは自動的に生成されません。
重要

autoGeneratePk パラメータは個別に変更できません。 autoGeneratePk パラメータは、writeHa パラメータが false から true に更新された場合にのみ有効になります。

writePolicy

String

sync

一時的な切り替え同期と非同期高可用性を設定します。有効値:

  • sync: 非同期書き込みから同期書き込みに一時的に切り替えます。
  • async: 同期書き込みが一時的に有効になった後、非同期書き込みが高可用性に復元されます。
説明

このパラメータは、高可用性が有効で、writeHa パラメータが true に設定されている場合にのみ有効です。このフィールドを設定するときに writeHa フィールドを指定する必要はありません。

Tag

タグ。

パラメータ

タイプ

説明

tagKey

String

env

タグのキー。

tagValue

String

dev

タグの値。

WarmNodeConfiguration

ウォームノードの構成。

パラメータ

タイプ

説明

diskType

String

cloud_efficiency

コールドデータノードのストレージタイプ。有効値: cloud_efficiency (Ultra ディスク)。

diskEncryption

Boolean

false

コールドデータノードのディスク暗号化を有効にするかどうか:

  • true: 機能を有効にします。
  • false: 機能を無効にします。

amount

Long

3

コールドデータノードの数。

spec

String

elasticsearch.sn2ne.large

コールドデータノードの仕様。詳細については、「製品仕様」をご参照ください。

disk

Long

500

コールドデータノードのストレージ容量。単位: GB。

performanceLevel

String

PL1

ディスクのパフォーマンスレベル (PL)。このパラメータは、ディスクのカテゴリが ESSD の場合にのみ有効です。コールドデータノードのディスクタイプが拡張 SSD の場合に必須です。サポートされているもの: PL1、PL2、および PL3。

WhiteIpGroup

IP アドレスホワイトリストが属するグループ。

パラメータ

タイプ

説明

groupName

String

test_group

IP ホワイトリストの名前。

WhiteIpType

String

PRIVATE_ES

IP アドレスホワイトリストのタイプ。有効値:

  • PRIVATE_ES
  • PUBLIC_ES
  • PRIVATE_KIBANA
  • PUBLIC_KIBANA

ips

String の配列

["10.2.xx.xx", "10.3.xx.xx"]

ホワイトリストグループ内の IP アドレスホワイトリスト。

ZoneInfo

ゾーン ID。

パラメータ

タイプ

説明

status

String

NORMAL

ゾーンステータス。有効値:

  • ISOLATION: 無効
  • NORMAL: 正常

zoneId

String

cn-hangzhou-b

ゾーンの ID。これはゾーンの一意の識別子です。