Commonly used parameters - Elasticsearch - Alibaba Cloud Documentation Center

ClientNodeConfiguration

The configurations of client nodes.

Parameter	Type	Example	Description
diskType	String	cloud_efficiency	The storage type of the coordinator node. Valid value: cloud_efficiency (ultra disk).
amount	Long	3	The number of coordinator nodes.
spec	String	elasticsearch.sn2ne.large	Coordinated node specifications. For more information, see Product specifications.
disk	Long	20	The storage space of the coordinator node. Unit: GB.

DictInfo

The dictionary configuration information.

Parameter	Type	Example	Description
type	String	ALI_WS	The type of the dictionary file. Valid values: STOP: stopword list MAIN: main dictionary SYNONYMS: synonym dictionary ALI_WS: Alibaba Cloud dictionary
sourceType	String	OSS	The source type of the dictionary file. Valid values: OSS: Object Storage Service (OSS). You must make sure that the ACL of the related OSS bucket is public read. ORIGIN: Open source Elasticsearch UPLOAD: uploaded files
fileSize	Long	2782602	The size of the dictionary file. Unit: bytes.
name	String	aliws_ext_dict.txt	The name of the dictionary file. Before you configure this annotation, take note of the following requirements: Main dictionary /stopwords: one word per line, saved as a UTF-8 encoded DIC file;. The file name can contain letters, digits, and underscores, and can be up to 30 characters in length. You cannot upload a file with the same name as the file. Synonym Dictionary: Each line has only one synonym expression, which is saved as a UTF-8-encoded TXT file. Ali dictionary: the file name must be aliws_ext_dict.txt; the file format must be UTF-8 format; the file content must be one word per line, and there must be no blank characters before and after; you need to use UNIX or Linux line breaks, that is, the end of each line is \n. If the dictionary file is generated in Windows, you must use the dos2unix tool to convert the file before you upload it.

ElasticDataNodeConfiguration

The configuration of the elastic data node.

Parameter	Type	Example	Description
diskType	String	cloud_ssd	The storage type of elastic nodes. Supported storage types: cloud_ssd: SSD cloud_essd: enhanced SSD (ESSD) cloud_efficiency: ultra disk.
diskEncryption	Boolean	false	Whether to enable disk encryption for the elastic node: true: enables the feature. false: disables the feature.
amount	Long	3	The number of elastic nodes.
spec	String	elasticsearch.sn2ne.large	Elastic node specifications. For more information, see Product specifications.
disk	Long	20	The storage space of the elastic node. Unit: GB.
performanceLevel	String	PL1	The performance level (PL) of the disk. This parameter is valid only if the category of the disk is ESSD. This property is required when the disk type of the elastic node is set to Enhanced SSD. Supported: PL1, PL2, and PL3.

Elasticsearch

Elasticsearchsh the instance configuration information.

Parameter	Type	Example	Description
masterConfiguration	MasterNodeConfiguration		The configurations of dedicated master nodes.
resourceGroupId	String	rg-aekzvowej3i****	The ID of the resource group to which the instance belongs.
elasticDataNodeConfiguration	ElasticDataNodeConfiguration		The configurations of elastic nodes.
dedicateMaster	Boolean	false	Whether to include the old dedicated master node (obsolete).
createdAt	String	2018-07-13T03:58:07.253Z	The time when the instance was created.
ikHotDicts	Array of DictInfo		The configuration of the IK hotword dictionary.
port	Long	9200	The private port number of the instance.
kibanaPrivateIPWhitelist	Array of String	["192.168.XX.XX"]	The list of private IP addresses in the whitelist of Kibana.
esVersion	String	6.3.2_with_X-Pack	The version of the instance.
kibanaConfiguration	KibanaNodeConfiguration		The configurations of Kibana nodes.
dataNode	Boolean	true	Indicates whether the instance contains data nodes. true false
serviceVpc	Boolean	true	Indicates whether the instance is in the Elasticsearch Service VPC. true: in false: Not in
tags	Array of Tag		The tags of the instance.
haveKibana	Boolean	true	Whether the instance contains a Kibana node: true false
dictList	Array of DictInfo		The configurations of IK dictionaries.
extendConfigs	Array of Object	[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]	Additional configurations of the instance.
status	String	active	The status of the instance. Valid values: active: The cluster is normal. activating: The cluster is being activated. Inactive: The cluster is frozen. invalid: The cluster is valid.
instanceId	String	es-cn-3h4k3axh33th9****	The instance ID.
zoneInfos	Array of ZoneInfo		The zone where the instance resides.
kibanaProtocol	String	HTTPS	Kibana access protocol. HTTP and HTTPS are supported.
enableKibanaPrivateNetwork	Boolean	false	Whether to enable private network access for Kibana: true: enables the feature. false: disables the feature.
kibanaDomain	String	es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com	The public endpoint of the Kibana console of the cluster.
nodeSpec	NodeSpec		The configurations of data nodes.
warmNode	Boolean	false	Whether to enable the cold data node: true: enables the feature. false: disables the feature.
warmNodeConfiguration	WarmNodeConfiguration		The configurations of warm nodes.
domain	String	es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com	The private endpoint of the Elasticsearch instance.
haveClientNode	Boolean	false	Whether to enable the coordinator node: true: enables the feature. false: disables the feature.
clientNodeConfiguration	ClientNodeConfiguration		The configurations of client nodes.
description	String	es-cn-abc	The instance name.
endTime	Long	5	The time when the instance expires. Unit: years. Pay-as-you-go instances are 100 years by default.
enablePublic	Boolean	true	Whether to enable the public endpoint of the instance: true: enables the feature. false: disables the feature.
aliwsDicts	Array of DictInfo		The Aliws dictionary configuration.
advancedDedicateMaster	Boolean	true	Whether to enable the new version of dedicated master nodes: true: enables the feature. false: disables the feature.
paymentType	String	prepaid	The billing method of the instance. Supported values: prepaid: subscription postpaid: pay-as-you-go
readWritePolicy	ReadWritePolicy		The configuration information about the high availability feature of the instance.
protocol	String	HTTP	The access protocol of the instance. Valid values: HTTP and HTTPS.
publicIpWhitelist	Array of String	["0.0.0.0/0"]	The public endpoint whitelist of the instance.
kibanaPort	Long	5601	The public network port number of Kibana.
enableKibanaPublicNetwork	Boolean	true	Whether to enable Internet access for Kibana: true: enables the feature. false: disables the feature.
networkConfig	NetworkConfig		The network configuration of the instance.
productType	String	generalBusiness	The version type of the instance. Valid values: logEnhancement: Log Enhanced Edition generalBusiness: General Business Edition
advancedSetting	Object		The advanced configurations.
gcName	String	CMS	The name of the garbage collector (GC). Supports CMS and G1.
nodeAmount	Long	2	The number of data nodes.
updatedAt	String	2018-07-13T03:58:07.253Z	The time when the instance was last updated.
esConfig	Map		The YML file configuration of the cluster.
esIPWhitelist	Array of String	["0.0.0.0/0"]	The list of private network access whitelists.
kibanaIPWhitelist	Array of String	["0.0.0.0/0"]	Kibana public endpoint access whitelist list.
privateNetworkIpWhiteList	Array of String	["0.0.0.0/0"]	The IP address whitelist of the instance.
synonymsDicts	Array of DictInfo		The synonym dictionary configuration of the instance.
haveElasticDataNode	Boolean	false	Whether to enable elastic data nodes: true: enables the feature. false: disables the feature.
zoneCount	Long	1	The number of zones in which you want to deploy the Elasticsearch cluster.
kibanaPrivateDomain	String	es-cn-tl329rbpc0001****-kibana.internal.elasticsearch.aliyuncs.com	The private endpoint of Kibana.
kibanaPrivatePort	Long	5601	The private port number of Kibana.
publicDomain	String	es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com	The address that is used to access the Elasticsearch cluster over the Internet.
publicPort	Long	9200	The public port number of the Elasticsearch instance.

KibanaNodeConfiguration

The configuration of Kibana nodes.

Parameter	Type	Example	Description
amount	Long	2	The number of Kibana nodes. Only one Kibana node is supported.
spec	String	elasticsearch.sn2ne.large	The specification of Kibana nodes. For more information, see Product specifications.
disk	Long	20	The storage capacity of the Kibana node. Unit: GB.

Logstash

The parameter object.

Parameter	Type	Example	Description
endpointList	Array		The node information.
host	String	172.16.xx.xx	The IP address of the node.
port	Long	9200	The port number used to access the node.
zoneId	String	cn-hangzhou-i	The zone ID of the node.
status	String	NORMAL	The status of the zone. Valid values: ISOLATION: disabled NORMAL: normal
description	String	ls-cn-abc	The instance name.
resourceGroupId	String	rg-acfm2h5vbzd****	The ID of the resource group to which the ECS instances belong.
endTime	Long	4749897600000	The last expiration time of the instance.
instanceId	String	ls-cn-n6w1o5jq****	The instance ID.
config	Map		Configure ECS instances.
createdAt	String	2018-07-13T03:58:07.253Z	The time when the instance was created.
networkConfig	Object		The network configurations.
type	String	vpc	The network type. Only Virtual Private Cloud (VPC) is supported.
vpcId	String	vpc-abc	The VPC ID.
vsArea	String	cn-hangzhou-*	Select a zone for the NLB instance.
vswitchId	String	vsw-def	The vSwitch ID.
zoneInfos	Array		The zone IDs.
status	String	NORMAL	The status of the zone. Valid values: ISOLATION: disabled NORMAL: normal
zoneId	String	cn-hangzhou-i	The zone ID.
nodeAmount	Long	2	The number of nodes in the cluster.
updatedAt	String	2018-07-18T10:10:04.484Z	The time when the instance was last updated.
version	String	6.7.0_with_X-Pack	The version of the instance. Valid values: 6.7.0_with_X-Pack 7.4.0_with_X-Pack
dataNode	Boolean	true	Whether to enable data nodes. This parameter must be set to true.
nodeSpec	Object		The configurations of data nodes.
disk	Long	50	The disk size of the core node.
diskType	String	cloud_ssd	The disk category of the node.
spec	String	logstash.n4.small	The specifications of the node.
paymentType	String	postpaid	The billing method of the cluster. Valid values: prepaid: subscription postpaid: pay-as-you-go
protocol	String	HTTP	The access protocol of the instance.
tags	Array		The tags of the instance.
tagKey	String	env	The key of the tag.
tagValue	String	dev	The value of the tag.
zoneCount	Long	1	The number of zones in which you want to deploy the Elasticsearch cluster.

MasterNodeConfiguration

The configuration of the dedicated master node.

Parameter	Type	Example	Description
amount	Long	3	The number of dedicated master nodes.
spec	String	elasticsearch.sn2ne.large	The specifications of dedicated master nodes. For more information, see Product specifications.
disk	Long	20	The storage space of the dedicated master node. Unit: GB.
diskType	String	cloud_essd	The storage type of the dedicated master node. Supported: cloud_ssd: standard SSD. cloud_essd (default): Enhanced SSD

NetworkConfig

The network configurations.

Parameter	Type	Example	Description
type	String	vpc	The network type. Only Virtual Private Cloud is supported.
vpcId	String	vpc-bp1xk0naij7jx4ph1****	The VPC ID.
whiteIpGroupList	Array of WhiteIpGroup		The configuration of the IP address whitelist. You cannot specify an IP address whitelist when you create an instance. You need to separately use the API to set whitelists for different roles.
vswitchId	String	vsw-bp1ogpdintii5qvyx****	The vSwitch ID.
vsArea	String	cn-hangzhou-e	The ID of the zone to which the network belongs.

NodeInfo

The node information.

Parameter	Type	Example	Description
host	String	172.16.xx.xx	The IP address of the node.
hostName	String	es-cn-tl32vdghe0005cd99-data-b-2	The name of the node. Only instances of the 7.16 version deployed based on ACK are supported.
port	Long	9200	The port number of the node.
zoneId	String	cn-hangzhou-b	The ID of the zone where the node resides.

NodeSpec

The configurations of data nodes.

Parameter	Type	Example	Description
diskType	String	cloud_ssd	The storage type of the data node. You can use the following types of data nodes: cloud_ssd: SSD cloud_essd: enhanced SSD (ESSD) cloud_efficiency: ultra disk.
spec	String	elasticsearch.sn2ne.large	The specifications of searcher workers. For more information, see Product specifications. Note When you use createInstance to create a cloud-native instance of a new generation of disk-type data nodes in the China (Beijing), China (Shanghai), China (Hangzhou), or China (Shenzhen) region, you must specify the instance family and suffix `.new`, for example, Elasticsearch. sn1 ne.large.new.
disk	Integer	20	The storage space of the data node. Unit: GB.
diskEncryption	Boolean	false	Whether to enable disk encryption for data nodes: true: enables the feature. false: disables the feature.
performanceLevel	String	PL1	The performance level (PL) of the disk. This parameter is valid only if the category of the disk is ESSD. This parameter is required when the disk type of the data node is Enhanced SSD. Supported: PL1, PL2, and PL3.

PaymentInfo

The billing details of the cluster.

Parameter	Type	Example	Description
duration	Long	1	The time when the instance was purchased. This parameter is required. Monthly and yearly purchases are supported.
pricingCycle	String	Month	Subscription unit, required. Optional values: Year Month
isAutoRenew	Boolean	true	Indicates whether to enable auto-renewal settings. Valid values: true false: disables the feature. This is the default value.
autoRenewDuration	Long	3	The auto-renewal duration. Unit: months. isAutoRenew is required when the parameter is set to true. The range of parameter values is the same as that on the purchase page.

ReadWritePolicy

The parameter configurations of the high availability feature.

Parameter	Type	Example	Description
writeHa	Boolean	true	Indicates whether the write high availability feature is enabled. true: enables the feature. false: disables the feature.
autoGeneratePk	Boolean	true	Whether to automatically generate a document hash value primary key if no primary key exists: true: automatically generates a primary key. This is the default value. false: The primary key is not automatically generated. Important The autoGeneratePk parameter cannot be modified separately. The autoGeneratePk parameter takes effect only when the writeHa parameter is updated from false to true.
writePolicy	String	sync	Set temporary switching synchronization and asynchronous high available. Valid values: sync: temporarily switches from asynchronous writing to synchronous writing. async: After synchronous writing is temporarily enabled, asynchronous writing is restored to high availability. Note This parameter is valid only when high availability is enabled and the writeHa parameter is set to true. You do not need to specify the writeHa field when you set this field.

Parameter

Type

Example

Description

writeHa

Boolean

true

Indicates whether the write high availability feature is enabled.

true: enables the feature.
false: disables the feature.

autoGeneratePk

Boolean

true

Whether to automatically generate a document hash value primary key if no primary key exists:

true: automatically generates a primary key. This is the default value.
false: The primary key is not automatically generated.

Important

The autoGeneratePk parameter cannot be modified separately. The autoGeneratePk parameter takes effect only when the writeHa parameter is updated from false to true.

writePolicy

String

sync

Set temporary switching synchronization and asynchronous high available. Valid values:

sync: temporarily switches from asynchronous writing to synchronous writing.
async: After synchronous writing is temporarily enabled, asynchronous writing is restored to high availability.

Note

This parameter is valid only when high availability is enabled and the writeHa parameter is set to true. You do not need to specify the writeHa field when you set this field.

Tag

The tags.

Parameter	Type	Example	Description
tagKey	String	env	The key of the tag.
tagValue	String	dev	The value of the tag.

WarmNodeConfiguration

The configurations of warm nodes.

Parameter	Type	Example	Description
diskType	String	cloud_efficiency	The storage type of the cold data node. Valid value: cloud_efficiency (Ultra Disk).
diskEncryption	Boolean	false	Whether to enable disk encryption for cold data nodes: true: enables the feature. false: disables the feature.
amount	Long	3	The number of cold data nodes.
spec	String	elasticsearch.sn2ne.large	Cold data node specifications. For more information, see Product specifications.
disk	Long	500	The storage space of the cold data node. Unit: GB.
performanceLevel	String	PL1	The performance level (PL) of the disk. This parameter is valid only if the category of the disk is ESSD. Required if the disk type of the cold data node is Enhanced SSD. Supported: PL1, PL2, and PL3.

WhiteIpGroup

The group to which the IP address whitelist belongs.

Parameter	Type	Example	Description
groupName	String	test_group	The name of the IP whitelist.
WhiteIpType	String	PRIVATE_ES	The type of the IP address whitelist. Valid values: PRIVATE_ES PUBLIC_ES PRIVATE_KIBANA PUBLIC_KIBANA
ips	Array of String	["10.2.xx.xx", "10.3.xx.xx"]	The IP address whitelist in the whitelist group.

Parameter

Type

Example

Description

groupName

String

test_group

The name of the IP whitelist.

WhiteIpType

String

PRIVATE_ES

The type of the IP address whitelist. Valid values:

PRIVATE_ES
PUBLIC_ES
PRIVATE_KIBANA
PUBLIC_KIBANA

ips

Array of String

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

The IP address whitelist in the whitelist group.

ZoneInfo

The zone IDs.

Parameter	Type	Example	Description
status	String	NORMAL	The zone status. Valid values: ISOLATION: disabled NORMAL: normal
zoneId	String	cn-hangzhou-b	The ID of the zone. It is the unique identifier of the zone.

Parameter

Type

Example

Description

status

String

NORMAL

The zone status. Valid values:

ISOLATION: disabled
NORMAL: normal

zoneId

String

cn-hangzhou-b

The ID of the zone. It is the unique identifier of the zone.