Paramètres couramment utilisés - Elasticsearch - Centre de documentation Alibaba Cloud

ClientNodeConfiguration

Configuration des nœuds client.

Parameter	Type	Example	Description
diskType	String	cloud_efficiency	Type de stockage du nœud de coordination. Valeur valide : cloud_efficiency (Ultra Disk).
amount	Long	3	Nombre de nœuds de coordination.
spec	String	elasticsearch.sn2ne.large	Spécifications du nœud de coordination. Pour plus d'informations, consultez Spécifications du produit.
disk	Long	20	Espace de stockage du nœud de coordination. Unité : Go.

Parameter

Type

Example

Description

diskType

String

cloud_efficiency

Type de stockage du nœud de coordination. Valeur valide : cloud_efficiency (Ultra Disk).

amount

Long

3

Nombre de nœuds de coordination.

spec

String

elasticsearch.sn2ne.large

Spécifications du nœud de coordination. Pour plus d'informations, consultez Spécifications du produit.

disk

Long

20

Espace de stockage du nœud de coordination. Unité : Go.

DictInfo

Configuration du dictionnaire.

Parameter	Type	Example	Description
type	String	ALI_WS	Type du fichier de dictionnaire. Valeurs valides : STOP : liste de mots vides MAIN : dictionnaire principal SYNONYMS : dictionnaire de synonymes ALI_WS : dictionnaire Alibaba Cloud
sourceType	String	OSS	Type de source du fichier de dictionnaire. Valeurs valides : OSS : Object Storage Service (OSS). Assurez-vous que l'ACL du bucket OSS associé est définie sur lecture publique. ORIGIN : Elasticsearch open source UPLOAD : fichiers téléchargés
fileSize	Long	2782602	Taille du fichier de dictionnaire. Unité : octets.
name	String	aliws_ext_dict.txt	Nom du fichier de dictionnaire. Avant de configurer ce paramètre, prenez en compte les exigences suivantes : Dictionnaire principal /stopwords : un mot par ligne, enregistré dans un fichier DIC encodé en UTF-8. Le nom du fichier peut contenir des lettres, des chiffres et des traits de soulignement, avec une longueur maximale de 30 caractères. Vous ne pouvez pas télécharger un fichier portant le même nom qu'un fichier existant. Dictionnaire de synonymes : chaque ligne contient une seule expression de synonyme, enregistrée dans un fichier TXT encodé en UTF-8. Dictionnaire Ali : le nom du fichier doit être aliws_ext_dict.txt ; le format du fichier doit être UTF-8 ; le contenu doit comporter un mot par ligne, sans espaces avant ni après ; utilisez des sauts de ligne UNIX ou Linux (chaque ligne se termine par \n). Si le fichier a été généré sous Windows, convertissez-le à l'aide de l'outil dos2unix avant de le télécharger.

ElasticDataNodeConfiguration

Configuration des nœuds de données élastiques.

Parameter	Type	Example	Description
diskType	String	cloud_ssd	Type de stockage des nœuds élastiques. Valeurs valides : cloud_ssd : SSD cloud_essd : Enhanced SSD (ESSD) cloud_efficiency : Ultra Disk.
diskEncryption	Boolean	false	Indique s'il faut activer le chiffrement du disque pour le nœud élastique. true : active la fonctionnalité. false : désactive la fonctionnalité.
amount	Long	3	Nombre de nœuds élastiques.
spec	String	elasticsearch.sn2ne.large	Spécifications du nœud élastique. Pour plus d'informations, consultez Spécifications du produit.
disk	Long	20	Espace de stockage du nœud élastique. Unité : Go.
performanceLevel	String	PL1	Niveau de performance (PL) du disque. Ce paramètre n'est valide que lorsque le type de disque est ESSD. Obligatoire si le type de disque du nœud élastique est défini sur Enhanced SSD. Valeurs valides : PL1, PL2 et PL3.

Elasticsearch

Configuration de l'instance Elasticsearch.

Parameter	Type	Example	Description
masterConfiguration	MasterNodeConfiguration		Configuration des nœuds maîtres dédiés.
resourceGroupId	String	rg-aekzvowej3i****	ID du groupe de ressources auquel appartient l'instance.
elasticDataNodeConfiguration	ElasticDataNodeConfiguration		Configuration des nœuds élastiques.
dedicateMaster	Boolean	false	Indique si l'ancien nœud maître dédié est inclus (obsolète).
createdAt	String	2018-07-13T03:58:07.253Z	Heure de création de l'instance.
ikHotDicts	Array of DictInfo		Configuration du dictionnaire de mots clés dynamiques IK.
port	Long	9200	Numéro de port privé de l'instance.
kibanaPrivateIPWhitelist	Array of String	["192.168.XX.XX"]	Liste d'autorisation d'adresses IP privées pour Kibana.
esVersion	String	6.3.2_with_X-Pack	Version de l'instance.
kibanaConfiguration	KibanaNodeConfiguration		Configuration des nœuds Kibana.
dataNode	Boolean	true	Indique si l'instance contient des nœuds de données. true false
serviceVpc	Boolean	true	Indique si l'instance se trouve dans le VPC du service Elasticsearch. true : oui false : non
tags	Array of Tag		Tags de l'instance.
haveKibana	Boolean	true	Indique si l'instance contient un nœud Kibana. true false
dictList	Array of DictInfo		Configuration des dictionnaires IK.
extendConfigs	Array of Object	[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]	Configurations supplémentaires de l'instance.
status	String	active	État de l'instance. Valeurs valides : active : le cluster fonctionne normalement. activating : le cluster est en cours d'activation. Inactive : le cluster est gelé. invalid : le cluster est valide.
instanceId	String	es-cn-3h4k3axh33th9****	ID de l'instance.
zoneInfos	Array of ZoneInfo		Zone où réside l'instance.
kibanaProtocol	String	HTTPS	Protocole d'accès pour Kibana. Valeurs valides : HTTP et HTTPS.
enableKibanaPrivateNetwork	Boolean	false	Indique s'il faut activer l'accès au réseau privé pour Kibana. true : active la fonctionnalité. false : désactive la fonctionnalité.
kibanaDomain	String	es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com	Endpoint public de la console Kibana du cluster.
nodeSpec	NodeSpec		Configuration des nœuds de données.
warmNode	Boolean	false	Indique s'il faut activer les nœuds warm. true : active la fonctionnalité. false : désactive la fonctionnalité.
warmNodeConfiguration	WarmNodeConfiguration		Configuration des nœuds warm.
domain	String	es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com	Endpoint privé de l'instance Elasticsearch.
haveClientNode	Boolean	false	Indique s'il faut activer les nœuds de coordination. true : active la fonctionnalité. false : désactive la fonctionnalité.
clientNodeConfiguration	ClientNodeConfiguration		Configuration des nœuds client.
description	String	es-cn-abc	Nom de l'instance.
endTime	Long	5	Date d'expiration de l'instance. Unité : années. La valeur par défaut pour les instances en paiement à l'utilisation est de 100 ans.
enablePublic	Boolean	true	Indique s'il faut activer l'endpoint public de l'instance. true : active la fonctionnalité. false : désactive la fonctionnalité.
aliwsDicts	Array of DictInfo		Configuration du dictionnaire de segmentation de mots Alibaba Cloud (aliws).
advancedDedicateMaster	Boolean	true	Indique s'il faut activer la nouvelle version des nœuds maîtres dédiés. true : active la fonctionnalité. false : désactive la fonctionnalité.
paymentType	String	prepaid	Mode de facturation de l'instance. Valeurs valides : prepaid : abonnement postpaid : paiement à l'utilisation
readWritePolicy	ReadWritePolicy		Informations de configuration relatives à la haute disponibilité de l'instance.
protocol	String	HTTP	Protocole d'accès de l'instance. Valeurs valides : HTTP et HTTPS.
publicIpWhitelist	Array of String	["0.0.0.0/0"]	Liste d'autorisation d'adresses IP publiques de l'instance.
kibanaPort	Long	5601	Numéro de port public de Kibana.
enableKibanaPublicNetwork	Boolean	true	Indique s'il faut activer l'accès Internet pour Kibana. true : active la fonctionnalité. false : désactive la fonctionnalité.
networkConfig	NetworkConfig		Configuration réseau de l'instance.
productType	String	generalBusiness	Type de version de l'instance. Valeurs valides : logEnhancement : Édition Log Enhanced generalBusiness : Édition General Business
advancedSetting	Object		Configurations avancées.
gcName	String	CMS	Nom du ramasse-miettes (GC). Valeurs valides : CMS et G1.
nodeAmount	Long	2	Nombre de nœuds de données.
updatedAt	String	2018-07-13T03:58:07.253Z	Heure de la dernière mise à jour de l'instance.
esConfig	Map		Configuration du fichier YML du cluster.
esIPWhitelist	Array of String	["0.0.0.0/0"]	Liste d'autorisation d'accès au réseau privé de l'instance.
kibanaIPWhitelist	Array of String	["0.0.0.0/0"]	Liste d'autorisation d'accès à l'endpoint public pour Kibana.
privateNetworkIpWhiteList	Array of String	["0.0.0.0/0"]	Liste d'autorisation d'adresses IP de l'instance.
synonymsDicts	Array of DictInfo		Configuration du dictionnaire de synonymes de l'instance.
haveElasticDataNode	Boolean	false	Indique s'il faut activer les nœuds de données élastiques. true : active la fonctionnalité. false : désactive la fonctionnalité.
zoneCount	Long	1	Nombre de zones dans lesquelles déployer le cluster Elasticsearch.
kibanaPrivateDomain	String	es-cn-tl329rbpc0001****-kibana.internal.elasticsearch.aliyuncs.com	Endpoint privé de Kibana.
kibanaPrivatePort	Long	5601	Numéro de port privé de Kibana.
publicDomain	String	es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com	Adresse utilisée pour accéder au cluster Elasticsearch via Internet.
publicPort	Long	9200	Numéro de port public de l'instance Elasticsearch.

KibanaNodeConfiguration

Configuration des nœuds Kibana.

Parameter	Type	Example	Description
amount	Long	2	Nombre de nœuds Kibana. Un seul nœud Kibana est pris en charge.
spec	String	elasticsearch.sn2ne.large	Spécifications des nœuds Kibana. Pour plus d'informations, consultez Spécifications du produit.
disk	Long	20	Capacité de stockage du nœud Kibana. Unité : Go.

Parameter

Type

Example

Description

amount

Long

2

Nombre de nœuds Kibana. Un seul nœud Kibana est pris en charge.

spec

String

elasticsearch.sn2ne.large

Spécifications des nœuds Kibana. Pour plus d'informations, consultez Spécifications du produit.

disk

Long

20

Capacité de stockage du nœud Kibana. Unité : Go.

Logstash

Configuration de l'instance Logstash.

Parameter	Type	Example	Description
endpointList	Array		Informations sur les nœuds.
host	String	172.16.xx.xx	Adresse IP du nœud.
port	Long	9200	Numéro de port utilisé pour accéder au nœud.
zoneId	String	cn-hangzhou-i	ID de zone du nœud.
status	String	NORMAL	État de la zone. Valeurs valides : ISOLATION : désactivée NORMAL : normale
description	String	ls-cn-abc	Nom de l'instance.
resourceGroupId	String	rg-acfm2h5vbzd****	ID du groupe de ressources auquel appartient l'instance.
endTime	Long	4749897600000	Date d'expiration de l'instance.
instanceId	String	ls-cn-n6w1o5jq****	ID de l'instance.
config	Map		Configuration de l'instance.
createdAt	String	2018-07-13T03:58:07.253Z	Heure de création de l'instance.
networkConfig	Object		Configuration réseau.
type	String	vpc	Type de réseau. Seul le Virtual Private Cloud (VPC) est pris en charge.
vpcId	String	vpc-abc	ID du VPC.
vsArea	String	cn-hangzhou-*	Zone de l'instance.
vswitchId	String	vsw-def	ID du vSwitch.
zoneInfos	Array		ID des zones.
status	String	NORMAL	État de la zone. Valeurs valides : ISOLATION : désactivée NORMAL : normale
zoneId	String	cn-hangzhou-i	ID de la zone.
nodeAmount	Long	2	Nombre de nœuds dans le cluster.
updatedAt	String	2018-07-18T10:10:04.484Z	Heure de la dernière mise à jour de l'instance.
version	String	6.7.0_with_X-Pack	Version de l'instance. Valeurs valides : 6.7.0_with_X-Pack 7.4.0_with_X-Pack
dataNode	Boolean	true	Indique s'il faut activer les nœuds de données. Ce paramètre doit être défini sur true.
nodeSpec	Object		Configuration des nœuds de données.
disk	Long	50	Taille du disque du nœud central.
diskType	String	cloud_ssd	Catégorie de disque du nœud.
spec	String	logstash.n4.small	Spécifications du nœud.
paymentType	String	postpaid	Mode de facturation du cluster. Valeurs valides : prepaid : abonnement postpaid : paiement à l'utilisation
protocol	String	HTTP	Protocole d'accès de l'instance.
tags	Array		Tags de l'instance.
tagKey	String	env	Clé du tag.
tagValue	String	dev	Valeur du tag.
zoneCount	Long	1	Nombre de zones dans lesquelles déployer le cluster Elasticsearch.

MasterNodeConfiguration

Configuration des nœuds maîtres dédiés.

Parameter	Type	Example	Description
amount	Long	3	Nombre de nœuds maîtres dédiés.
spec	String	elasticsearch.sn2ne.large	Spécifications des nœuds maîtres dédiés. Pour plus d'informations, consultez Spécifications du produit.
disk	Long	20	Espace de stockage du nœud maître dédié. Unité : Go.
diskType	String	cloud_essd	Type de stockage du nœud maître dédié. Valeurs valides : cloud_ssd : SSD standard. cloud_essd (par défaut) : Enhanced SSD

NetworkConfig

Configuration réseau.

Parameter	Type	Example	Description
type	String	vpc	Type de réseau. Seul le Virtual Private Cloud est pris en charge.
vpcId	String	vpc-bp1xk0naij7jx4ph1****	ID du VPC.
whiteIpGroupList	Array of WhiteIpGroup		Configuration de la liste d'autorisation d'adresses IP. Vous ne pouvez pas spécifier de liste d'autorisation d'adresses IP lors de la création d'une instance. Utilisez l'opération API correspondante pour configurer séparément les listes d'autorisation selon les types de réseau.
vswitchId	String	vsw-bp1ogpdintii5qvyx****	ID du vSwitch.
vsArea	String	cn-hangzhou-e	ID de la zone à laquelle appartient le réseau.

Parameter

Type

Example

Description

type

String

vpc

Type de réseau. Seul le Virtual Private Cloud est pris en charge.

vpcId

String

vpc-bp1xk0naij7jx4ph1****

ID du VPC.

whiteIpGroupList

Array of WhiteIpGroup

Configuration de la liste d'autorisation d'adresses IP. Vous ne pouvez pas spécifier de liste d'autorisation d'adresses IP lors de la création d'une instance. Utilisez l'opération API correspondante pour configurer séparément les listes d'autorisation selon les types de réseau.

vswitchId

String

vsw-bp1ogpdintii5qvyx****

ID du vSwitch.

vsArea

String

cn-hangzhou-e

ID de la zone à laquelle appartient le réseau.

NodeInfo

Informations sur le nœud.

Parameter	Type	Example	Description
host	String	172.16.xx.xx	Adresse IP du nœud.
hostName	String	es-cn-tl32vdghe0005cd99-data-b-2	Nom du nœud. Seules les instances de la version 7.16 déployées via ACK sont prises en charge.
port	Long	9200	Numéro de port du nœud.
zoneId	String	cn-hangzhou-b	ID de la zone où réside le nœud.

Parameter

Type

Example

Description

host

String

172.16.xx.xx

Adresse IP du nœud.

hostName

String

es-cn-tl32vdghe0005cd99-data-b-2

Nom du nœud. Seules les instances de la version 7.16 déployées via ACK sont prises en charge.

port

Long

9200

Numéro de port du nœud.

zoneId

String

cn-hangzhou-b

ID de la zone où réside le nœud.

NodeSpec

Configuration des nœuds de données.

Parameter	Type	Example	Description
diskType	String	cloud_ssd	Type de stockage du nœud de données. Valeurs valides : cloud_ssd : SSD cloud_essd : Enhanced SSD (ESSD) cloud_efficiency : Ultra Disk.
spec	String	elasticsearch.sn2ne.large	Spécifications du nœud de données. Pour plus d'informations, consultez Spécifications du produit. Remarque Lorsque vous utilisez createInstance pour créer une instance cloud-native de nouvelle génération avec des nœuds de données de type disque dans la région Chine (Pékin), Chine (Shanghai), Chine (Hangzhou) ou Chine (Shenzhen), vous devez spécifier la famille d'instances et le suffixe `.new`, par exemple Elasticsearch.sn1ne.large.new.
disk	Integer	20	Espace de stockage du nœud de données. Unité : Go.
diskEncryption	Boolean	false	Indique s'il faut activer le chiffrement du disque pour les nœuds de données. true : active la fonctionnalité. false : désactive la fonctionnalité.
performanceLevel	String	PL1	Niveau de performance (PL) du disque. Ce paramètre n'est valide que lorsque le type de disque est ESSD. Obligatoire si le type de disque du nœud de données est Enhanced SSD. Valeurs valides : PL1, PL2 et PL3.

PaymentInfo

Détails de facturation du cluster.

Parameter	Type	Example	Description
duration	Long	1	Durée de l'abonnement. Les cycles de facturation mensuels et annuels sont tous deux pris en charge.
pricingCycle	String	Month	Unité du cycle de facturation. Valeurs valides : Year Month
isAutoRenew	Boolean	true	Indique s'il faut activer le renouvellement automatique. Valeurs valides : true false : désactive la fonctionnalité. Il s'agit de la valeur par défaut.
autoRenewDuration	Long	3	Durée du renouvellement automatique. Unité : mois. Le paramètre isAutoRenew est requis lorsque ce paramètre est défini sur true. La plage de valeurs correspond à celle disponible sur la page d'achat.

ReadWritePolicy

Configuration de la haute disponibilité.

Parameter	Type	Example	Description
writeHa	Boolean	true	Indique si la fonctionnalité de haute disponibilité en écriture est activée. true : active la fonctionnalité. false : désactive la fonctionnalité.
autoGeneratePk	Boolean	true	Indique s'il faut générer automatiquement une clé primaire basée sur le hachage du document en l'absence de clé primaire : true : génère automatiquement une clé primaire. Il s'agit de la valeur par défaut. false : la clé primaire n'est pas générée automatiquement. Important Le paramètre autoGeneratePk ne peut pas être modifié indépendamment. Il ne prend effet que lorsque le paramètre writeHa passe de false à true.
writePolicy	String	sync	Mode de haute disponibilité en écriture. Utilisez ce paramètre pour basculer temporairement entre les modes synchrone et asynchrone. Valeurs valides : sync : bascule temporairement de l'écriture asynchrone vers l'écriture synchrone. async : rétablit l'écriture asynchrone après l'activation temporaire de l'écriture synchrone. Remarque Ce paramètre n'est valide que si la haute disponibilité est activée et que le paramètre writeHa est défini sur true. Vous n'avez pas besoin de spécifier le champ writeHa lorsque vous définissez ce champ.

Parameter

Type

Example

Description

writeHa

Boolean

true

Indique si la fonctionnalité de haute disponibilité en écriture est activée.

true : active la fonctionnalité.
false : désactive la fonctionnalité.

autoGeneratePk

Boolean

true

Indique s'il faut générer automatiquement une clé primaire basée sur le hachage du document en l'absence de clé primaire :

true : génère automatiquement une clé primaire. Il s'agit de la valeur par défaut.
false : la clé primaire n'est pas générée automatiquement.

Important

Le paramètre autoGeneratePk ne peut pas être modifié indépendamment. Il ne prend effet que lorsque le paramètre writeHa passe de false à true.

writePolicy

String

sync

Mode de haute disponibilité en écriture. Utilisez ce paramètre pour basculer temporairement entre les modes synchrone et asynchrone. Valeurs valides :

sync : bascule temporairement de l'écriture asynchrone vers l'écriture synchrone.
async : rétablit l'écriture asynchrone après l'activation temporaire de l'écriture synchrone.

Remarque

Ce paramètre n'est valide que si la haute disponibilité est activée et que le paramètre writeHa est défini sur true. Vous n'avez pas besoin de spécifier le champ writeHa lorsque vous définissez ce champ.

Tag

Tags de l'instance.

Parameter	Type	Example	Description
tagKey	String	env	Clé du tag.
tagValue	String	dev	Valeur du tag.

Parameter

Type

Example

Description

tagKey

String

env

Clé du tag.

tagValue

String

dev

Valeur du tag.

WarmNodeConfiguration

Configuration des nœuds warm.

Parameter	Type	Example	Description
diskType	String	cloud_efficiency	Type de stockage du nœud de données froides. Valeur valide : cloud_efficiency (Ultra Disk).
diskEncryption	Boolean	false	Indique s'il faut activer le chiffrement du disque pour les nœuds warm. true : active la fonctionnalité. false : désactive la fonctionnalité.
amount	Long	3	Nombre de nœuds de données froides.
spec	String	elasticsearch.sn2ne.large	Spécifications du nœud de données froides. Pour plus d'informations, consultez Spécifications du produit.
disk	Long	500	Espace de stockage du nœud de données froides. Unité : Go.
performanceLevel	String	PL1	Niveau de performance (PL) du disque. Ce paramètre n'est valide que lorsque le type de disque est ESSD. Obligatoire si le type de disque du nœud warm est Enhanced SSD. Valeurs valides : PL1, PL2 et PL3.

WhiteIpGroup

Configuration du groupe de liste d'autorisation d'adresses IP.

Parameter	Type	Example	Description
groupName	String	test_group	Nom de la liste d'autorisation d'adresses IP.
WhiteIpType	String	PRIVATE_ES	Type de liste d'autorisation d'adresses IP. Valeurs valides : PRIVATE_ES PUBLIC_ES PRIVATE_KIBANA PUBLIC_KIBANA
ips	Array of String	["10.2.xx.xx", "10.3.xx.xx"]	Adresses IP figurant dans le groupe de liste d'autorisation.

Parameter

Type

Example

Description

groupName

String

test_group

Nom de la liste d'autorisation d'adresses IP.

WhiteIpType

String

PRIVATE_ES

Type de liste d'autorisation d'adresses IP. Valeurs valides :

PRIVATE_ES
PUBLIC_ES
PRIVATE_KIBANA
PUBLIC_KIBANA

ips

Array of String

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

Adresses IP figurant dans le groupe de liste d'autorisation.

ZoneInfo

Informations sur la zone.

Parameter	Type	Example	Description
status	String	NORMAL	État de la zone. Valeurs valides : ISOLATION : désactivée NORMAL : normale
zoneId	String	cn-hangzhou-b	ID de la zone.

Parameter

Type

Example

Description

status

String

NORMAL

État de la zone. Valeurs valides :

ISOLATION : désactivée
NORMAL : normale

zoneId

String

cn-hangzhou-b

ID de la zone.