Todos os produtos
Search
Central de documentação

Elasticsearch:Parâmetros mais utilizados

Última atualização: Jul 02, 2026

ClientNodeConfiguration

Configurações de nós coordenadores.

Parâmetro

Tipo

Exemplo

Descrição

diskType

String

cloud_efficiency

Tipo de armazenamento do nó coordenador. Valor válido: cloud_efficiency (disco ultra).

amount

Long

3

Quantidade de nós coordenadores.

spec

String

elasticsearch.sn2ne.large

Especificações do nó coordenador. Para mais informações, consulte Especificações do produto.

disk

Long

20

Espaço de armazenamento do nó coordenador. Unidade: GB.

DictInfo

Configuração de dicionário.

Parâmetro

Tipo

Exemplo

Descrição

type

String

ALI_WS

Tipo do arquivo de dicionário. Valores válidos:

  • STOP: lista de stopwords
  • MAIN: dicionário principal
  • SYNONYMS: dicionário de sinônimos
  • ALI_WS: dicionário da Alibaba Cloud

sourceType

String

OSS

Tipo de source do arquivo de dicionário. Valores válidos:

  • OSS: Object Storage Service (OSS). A ACL do bucket OSS relacionado deve estar definida como leitura pública.
  • ORIGIN: Elasticsearch open source
  • UPLOAD: arquivos enviados

fileSize

Long

2.782.602

Tamanho do arquivo de dicionário. Unidade: bytes.

name

String

aliws_ext_dict.txt

Nome do arquivo de dicionário. Antes de configurar este parâmetro, observe os seguintes requisitos:

  • Dicionário principal /stopwords: uma palavra por linha, salvo como arquivo DIC codificado em UTF-8. O nome do arquivo pode conter letras, dígitos e sublinhados, com até 30 caracteres. Não é permitido enviar um arquivo com o mesmo nome.
  • Dicionário de sinônimos: cada linha deve ter apenas uma expressão de sinônimo, salva como arquivo TXT codificado em UTF-8.
  • Dicionário Ali: o nome do arquivo deve ser aliws_ext_dict.txt; o formato deve ser UTF-8; o conteúdo deve ter uma palavra por linha, sem espaços em branco antes ou depois; utilize quebras de linha UNIX ou Linux (cada linha termina com \n). Se o arquivo for gerado no Windows, converta-o com a ferramenta dos2unix antes de fazer o upload.

ElasticDataNodeConfiguration

Configuração de nós de dados elásticos.

Parâmetro

Tipo

Exemplo

Descrição

diskType

String

cloud_ssd

Tipo de armazenamento dos nós elásticos. Valores válidos:

  • cloud_ssd: SSD
  • cloud_essd: SSD aprimorado (ESSD)
  • cloud_efficiency: disco ultra.

diskEncryption

Boolean

false

Defina se a criptografia de disco está ativada para o nó elástico.

  • true: ative o recurso.
  • false: desative o recurso.

amount

Long

3

Quantidade de nós elásticos.

spec

String

elasticsearch.sn2ne.large

Especificações do nó elástico. Para mais informações, consulte Especificações do produto.

disk

Long

20

Espaço de armazenamento do nó elástico. Unidade: GB.

performanceLevel

String

PL1

Nível de desempenho (PL) do disco. Este parâmetro é válido apenas quando o tipo de disco é ESSD. Obrigatório quando o tipo de disco do nó elástico for definido como SSD Aprimorado. Valores válidos: PL1, PL2 e PL3.

Elasticsearch

Configuração da instância Elasticsearch.

Parâmetro

Tipo

Exemplo

Descrição

masterConfiguration

MasterNodeConfiguration

Configurações dos nós mestres dedicados.

resourceGroupId

String

rg-aekzvowej3i****

ID do grupo de recursos ao qual a instância pertence.

elasticDataNodeConfiguration

ElasticDataNodeConfiguration

Configurações dos nós elásticos.

dedicateMaster

Boolean

false

Indica se o antigo nó mestre dedicado está incluído (obsoleto).

createdAt

String

2018-07-13T03:58:07.253Z

Horário de criação da instância.

ikHotDicts

Array of DictInfo

Configuração do dicionário de hotwords IK.

port

Long

9200

Número da porta privada da instância.

kibanaPrivateIPWhitelist

Array of String

["192.168.XX.XX"]

Lista de permissões de endereços IP privados para o Kibana.

esVersion

String

6.3.2_with_X-Pack

Versão da instância.

kibanaConfiguration

KibanaNodeConfiguration

Configurações dos nós Kibana.

dataNode

Boolean

true

Indica se a instância contém nós de dados.

  • true
  • false

serviceVpc

Boolean

true

Indica se a instância está na VPC do Serviço Elasticsearch.

  • true: sim
  • false: não

tags

Array of Tag

Tags da instância.

haveKibana

Boolean

true

Indica se a instância contém um nó Kibana.

  • true
  • false

dictList

Array of DictInfo

Configurações dos dicionários IK.

extendConfigs

Array of Object

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

Configurações adicionais da instância.

status

String

active

Status da instância. Valores válidos:

  • active: O cluster está normal.
  • activating: O cluster está sendo ativado.
  • Inactive: O cluster está congelado.
  • invalid: O cluster é válido.

instanceId

String

es-cn-3h4k3axh33th9****

ID da instância.

zoneInfos

Array of ZoneInfo

Zona onde a instância reside.

kibanaProtocol

String

HTTPS

Protocolo de acesso ao Kibana. Valores válidos: HTTP e HTTPS.

enableKibanaPrivateNetwork

Boolean

false

Defina se o acesso à rede privada está ativado para o Kibana.

  • true: ative o recurso.
  • false: desative o recurso.

kibanaDomain

String

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

Endpoint público do console Kibana do cluster.

nodeSpec

NodeSpec

Configurações dos nós de dados.

warmNode

Boolean

false

Defina se os nós warm estão ativados.

  • true: ative o recurso.
  • false: desative o recurso.

warmNodeConfiguration

WarmNodeConfiguration

Configurações dos nós warm.

domain

String

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

Endpoint privado da instância Elasticsearch.

haveClientNode

Boolean

false

Defina se os nós coordenadores estão ativados.

  • true: ative o recurso.
  • false: desative o recurso.

clientNodeConfiguration

ClientNodeConfiguration

Configurações dos nós coordenadores.

description

String

es-cn-abc

Nome da instância.

endTime

Long

5

Data de expiração da instância. Unidade: anos. Instâncias com pagamento conforme o uso têm validade padrão de 100 anos.

enablePublic

Boolean

true

Defina se o endpoint público da instância está ativado.

  • true: ative o recurso.
  • false: desative o recurso.

aliwsDicts

Array of DictInfo

Configuração do dicionário de segmentação de palavras da Alibaba Cloud (aliws).

advancedDedicateMaster

Boolean

true

Defina se a nova versão dos nós mestres dedicados está ativada.

  • true: ative o recurso.
  • false: desative o recurso.

paymentType

String

prepaid

Método de faturamento da instância. Valores válidos:

  • prepaid: assinatura
  • postpaid: pagamento conforme o uso

readWritePolicy

ReadWritePolicy

Informações de configuração sobre o recurso de alta disponibilidade da instância.

protocol

String

HTTP

Protocolo de acesso da instância. Valores válidos: HTTP e HTTPS.

publicIpWhitelist

Array of String

["0.0.0.0/0"]

Lista de permissões de endpoint público da instância.

kibanaPort

Long

5601

Número da porta pública do Kibana.

enableKibanaPublicNetwork

Boolean

true

Defina se o acesso à internet está ativado para o Kibana.

  • true: ative o recurso.
  • false: desative o recurso.

networkConfig

NetworkConfig

Configuração de rede da instância.

productType

String

generalBusiness

Tipo de versão da instância. Valores válidos:

  • logEnhancement: Log Enhanced Edition
  • generalBusiness: General Business Edition

advancedSetting

Object

Configurações avançadas.

gcName

String

CMS

Nome do coletor de lixo (GC). Valores válidos: CMS e G1.

nodeAmount

Long

2

Quantidade de nós de dados.

updatedAt

String

2018-07-13T03:58:07.253Z

Horário da última atualização da instância.

esConfig

Map

Configuração do arquivo YML do cluster.

esIPWhitelist

Array of String

["0.0.0.0/0"]

Lista de permissões de acesso à rede privada da instância.

kibanaIPWhitelist

Array of String

["0.0.0.0/0"]

Lista de permissões de acesso ao endpoint público para o Kibana.

privateNetworkIpWhiteList

Array of String

["0.0.0.0/0"]

Lista de permissões de endereços IP da instância.

synonymsDicts

Array of DictInfo

Configuração do dicionário de sinônimos da instância.

haveElasticDataNode

Boolean

false

Defina se os nós de dados elásticos estão ativados.

  • true: ative o recurso.
  • false: desative o recurso.

zoneCount

Long

1

Número de zonas onde o cluster Elasticsearch será implantado.

kibanaPrivateDomain

String

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

Endpoint privado do Kibana.

kibanaPrivatePort

Long

5601

Número da porta privada do Kibana.

publicDomain

String

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

Endereço usado para acessar o cluster Elasticsearch pela internet.

publicPort

Long

9200

Número da porta pública da instância Elasticsearch.

KibanaNodeConfiguration

Configuração de nó Kibana.

Parâmetro

Tipo

Exemplo

Descrição

amount

Long

2

Quantidade de nós Kibana. Apenas um nó Kibana é suportado.

spec

String

elasticsearch.sn2ne.large

Especificação dos nós Kibana. Para mais informações, consulte Especificações do produto.

disk

Long

20

Capacidade de armazenamento do nó Kibana. Unidade: GB.

Logstash

Configuração da instância Logstash.

Parâmetro

Tipo

Exemplo

Descrição

endpointList

Array

Informações do nó.

host

String

172,16.xx.xx

Endereço IP do nó.

port

Long

9200

Número da porta usada para acessar o nó.

zoneId

String

cn-hangzhou-i

ID da zona do nó.

status

String

NORMAL

Status da zona. Valores válidos:

  • ISOLATION: desativado
  • NORMAL: normal

description

String

ls-cn-abc

Nome da instância.

resourceGroupId

String

rg-acfm2h5vbzd****

ID do grupo de recursos ao qual a instância pertence.

endTime

Long

4.749.897.600.000

Data de expiração da instância.

instanceId

String

ls-cn-n6w1o5jq****

ID da instância.

config

Map

Configuração da instância.

createdAt

String

2018-07-13T03:58:07.253Z

Horário de criação da instância.

networkConfig

Object

Configurações de rede.

type

String

vpc

Tipo de rede. Apenas Virtual Private Cloud (VPC) é suportado.

vpcId

String

vpc-abc

ID da VPC.

vsArea

String

cn-hangzhou-*

Zona da instância.

vswitchId

String

vsw-def

ID do vSwitch.

zoneInfos

Array

IDs das zonas.

status

String

NORMAL

Status da zona. Valores válidos:

  • ISOLATION: desativado
  • NORMAL: normal

zoneId

String

cn-hangzhou-i

ID da zona.

nodeAmount

Long

2

Quantidade de nós no cluster.

updatedAt

String

2018-07-18T10:10:04.484Z

Horário da última atualização da instância.

version

String

6.7.0_with_X-Pack

Versão da instância. Valores válidos:

  • 6.7.0_with_X-Pack
  • 7.4.0_with_X-Pack

dataNode

Boolean

true

Indica se os nós de dados estão ativados. Este parâmetro deve ser definido como true.

nodeSpec

Object

Configurações dos nós de dados.

disk

Long

50

Tamanho do disco do nó principal.

diskType

String

cloud_ssd

Categoria do disco do nó.

spec

String

logstash.n4.small

Especificações do nó.

paymentType

String

postpaid

Método de faturamento do cluster. Valores válidos:

  • prepaid: assinatura
  • postpaid: pagamento conforme o uso

protocol

String

HTTP

Protocolo de acesso da instância.

tags

Array

Tags da instância.

tagKey

String

env

Chave da tag.

tagValue

String

dev

Valor da tag.

zoneCount

Long

1

Número de zonas onde o cluster Elasticsearch será implantado.

MasterNodeConfiguration

Configuração de nó mestre dedicado.

Parâmetro

Tipo

Exemplo

Descrição

amount

Long

3

Quantidade de nós mestres dedicados.

spec

String

elasticsearch.sn2ne.large

Especificações dos nós mestres dedicados. Para mais informações, consulte Especificações do produto.

disk

Long

20

Espaço de armazenamento do nó mestre dedicado. Unidade: GB.

diskType

String

cloud_essd

Tipo de armazenamento do nó mestre dedicado. Valores válidos:

  • cloud_ssd: SSD padrão.
  • cloud_essd (padrão): SSD Aprimorado

NetworkConfig

Configuração de rede.

Parâmetro

Tipo

Exemplo

Descrição

type

String

vpc

Tipo de rede. Apenas Virtual Private Cloud é suportado.

vpcId

String

vpc-bp1xk0naij7jx4ph1****

ID da VPC.

whiteIpGroupList

Array of WhiteIpGroup

Configuração da lista de permissões de endereços IP. Não é possível especificar uma lista de permissões de IP durante a criação da instância. Utilize a operação de API correspondente para configurar listas de permissões separadamente para diferentes tipos de rede.

vswitchId

String

vsw-bp1ogpdintii5qvyx****

ID do vSwitch.

vsArea

String

cn-hangzhou-e

ID da zona à qual a rede pertence.

NodeInfo

Informações do nó.

Parâmetro

Tipo

Exemplo

Descrição

host

String

172,16.xx.xx

Endereço IP do nó.

hostName

String

es-cn-tl32vdghe0005cd99-data-b-2

Nome do nó. Suportado apenas para instâncias da versão 7.16 implantadas com base no ACK.

port

Long

9200

Número da porta do nó.

zoneId

String

cn-hangzhou-b

ID da zona onde o nó reside.

NodeSpec

Configuração de nó de dados.

Parâmetro

Tipo

Exemplo

Descrição

diskType

String

cloud_ssd

Tipo de armazenamento do nó de dados. Valores válidos:

  • cloud_ssd: SSD
  • cloud_essd: SSD aprimorado (ESSD)
  • cloud_efficiency: disco ultra.

spec

String

elasticsearch.sn2ne.large

Especificações do nó de dados. Para mais informações, consulte Especificações do produto.

Nota

Ao usar createInstance para criar uma instância nativa da nuvem de nova geração com nós de dados do tipo disco nas regiões China (Pequim), China (Xangai), China (Hangzhou) ou China (Shenzhen), especifique a família da instância e o sufixo .new, por exemplo, Elasticsearch.sn1ne.large.new.

disk

Integer

20

Espaço de armazenamento do nó de dados. Unidade: GB.

diskEncryption

Boolean

false

Defina se a criptografia de disco está ativada para os nós de dados.

  • true: ative o recurso.
  • false: desative o recurso.

performanceLevel

String

PL1

Nível de desempenho (PL) do disco. Este parâmetro é válido apenas quando o tipo de disco é ESSD. Obrigatório quando o tipo de disco do nó de dados for SSD Aprimorado. Valores válidos: PL1, PL2 e PL3.

PaymentInfo

Detalhes de faturamento do cluster.

Parâmetro

Tipo

Exemplo

Descrição

duration

Long

1

Duração da assinatura. Ciclos de faturamento mensal e anual são suportados.

pricingCycle

String

Month

Unidade do ciclo de faturamento. Valores válidos:

  • Year
  • Month

isAutoRenew

Boolean

true

Defina se a renovação automática está ativada. Valores válidos:

  • true
  • false: desative o recurso. Este é o valor padrão.

autoRenewDuration

Long

3

Duração da renovação automática. Unidade: meses. isAutoRenew é obrigatório quando o parâmetro estiver definido como true. O intervalo de valores do parâmetro é o mesmo da página de compra.

ReadWritePolicy

Configuração de alta disponibilidade.

Parâmetro

Tipo

Exemplo

Descrição

writeHa

Boolean

true

Indica se o recurso de alta disponibilidade de escrita está ativado.

  • true: ative o recurso.
  • false: desative o recurso.

autoGeneratePk

Boolean

true

Defina se uma chave primária baseada em hash do documento será gerada automaticamente caso não exista chave primária:

  • true: gera uma chave primária automaticamente. Este é o valor padrão.
  • false: A chave primária não é gerada automaticamente.
Importante

O parâmetro autoGeneratePk não pode ser modificado isoladamente. Ele só entra em vigor quando o parâmetro writeHa é atualizado de false para true.

writePolicy

String

sync

Modo de alta disponibilidade de escrita. Use este parâmetro para alternar temporariamente entre os modos síncrono e assíncrono. Valores válidos:

  • sync: alterna temporariamente da escrita assíncrona para a síncrona.
  • async: restaura a escrita assíncrona após a ativação temporária da escrita síncrona.
Nota

Este parâmetro é válido apenas quando a alta disponibilidade está ativada e o parâmetro writeHa está definido como true. Não é necessário especificar o campo writeHa ao definir este campo.

Tag

Tags da instância.

Parâmetro

Tipo

Exemplo

Descrição

tagKey

String

env

Chave da tag.

tagValue

String

dev

Valor da tag.

WarmNodeConfiguration

Configuração de nó warm.

Parâmetro

Tipo

Exemplo

Descrição

diskType

String

cloud_efficiency

Tipo de armazenamento do nó de dados frios. Valor válido: cloud_efficiency (Disco Ultra).

diskEncryption

Boolean

false

Defina se a criptografia de disco está ativada para os nós warm.

  • true: ative o recurso.
  • false: desative o recurso.

amount

Long

3

Quantidade de nós de dados frios.

spec

String

elasticsearch.sn2ne.large

Especificações do nó de dados frios. Para mais informações, consulte Especificações do produto.

disk

Long

500

Espaço de armazenamento do nó de dados frios. Unidade: GB.

performanceLevel

String

PL1

Nível de desempenho (PL) do disco. Este parâmetro é válido apenas quando o tipo de disco é ESSD. Obrigatório quando o tipo de disco do nó warm for SSD Aprimorado. Valores válidos: PL1, PL2 e PL3.

WhiteIpGroup

Configuração de grupo de lista de permissões de IP.

Parâmetro

Tipo

Exemplo

Descrição

groupName

String

test_group

Nome da lista de permissões de IP.

WhiteIpType

String

PRIVATE_ES

Tipo da lista de permissões de endereços IP. Valores válidos:

  • PRIVATE_ES
  • PUBLIC_ES
  • PRIVATE_KIBANA
  • PUBLIC_KIBANA

ips

Array of String

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

Endereços IP no grupo de lista de permissões.

ZoneInfo

Informações da zona.

Parâmetro

Tipo

Exemplo

Descrição

status

String

NORMAL

Status da zona. Valores válidos:

  • ISOLATION: desativado
  • NORMAL: normal

zoneId

String

cn-hangzhou-b

ID da zona.