检索分析服务Elasticsearch版API通用数据结构_检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

ClientNodeConfiguration

协调节点配置信息。

参数名称	类型	示例值	描述
diskType	String	cloud_efficiency	协调节点存储类型，仅支持cloud_efficiency（高效云盘）。
amount	Long	3	协调节点数量。
spec	String	elasticsearch.sn2ne.large	协调节点规格。规格信息可通过产品规格查看。
disk	Long	20	协调节点存储空间大小，单位：GB。

DictInfo

词典配置信息。

参数名称	类型	示例值	描述
type	String	ALI_WS	词典文件类型，支持： STOP：停用词 MAIN：主词典 SYNONYMS：同义词词典 ALI_WS：阿里词典
sourceType	String	OSS	词典文件来源类型，支持： OSS：OSS开放存储（需要确保OSS存储空间为公共可读） ORIGIN：开源Elasticsearch UPLOAD：上传的文件
fileSize	Long	2782602	词典文件大小，单位：Byte。
name	String	aliws_ext_dict.txt	词典文件名称。要求如下：主词典/停用词：每行一个词，保存为UTF-8编码的DIC文件；。文件名包含大小写字母、数字和下划线，且长度不超过30个字符；不允许上传同名文件，主分词文件和停用词文件也不允许重名。同义词词典：每行只有一个同义词表达式，保存为UTF-8编码的TXT文件。阿里词典：文件名必须是aliws_ext_dict.txt；文件格式必须是UTF-8格式；文件内容要求每行一个词，前后不能有空白字符；需要使用UNIX或Linux的换行符，即每行结尾是\n。如果是在Windows系统中生成的文件，需要在Linux机器上使用dos2unix工具将词典文件处理后再上传。

ElasticDataNodeConfiguration

弹性数据节点配置信息。

参数名称	类型	示例值	描述
diskType	String	cloud_ssd	弹性节点存储类型，支持： cloud_ssd：SSD云盘 cloud_essd：ESSD云盘 cloud_efficiency：高效云盘
diskEncryption	Boolean	false	是否为弹性节点开启云盘加密： true：开启 false：不开启
amount	Long	3	弹性节点数量。
spec	String	elasticsearch.sn2ne.large	弹性节点规格。规格信息可通过产品规格查看。
disk	Long	20	弹性节点存储空间大小，单位为GB。
performanceLevel	String	PL1	ESSD云盘的性能级别。当弹性节点的磁盘类型为ESSD云盘时，必选。支持：PL1、PL2、PL3。

Elasticsearch

Elasticsearchsh实例配置信息。

参数名称	类型	示例值	描述
masterConfiguration	MasterNodeConfiguration		专有主节点配置。
resourceGroupId	String	rg-aekzvowej3i****	实例所属的资源组ID。
elasticDataNodeConfiguration	ElasticDataNodeConfiguration		弹性数据节点配置。
dedicateMaster	Boolean	false	是否包含旧专有主节点（已废弃）。
createdAt	String	2018-07-13T03:58:07.253Z	实例创建时间。
ikHotDicts	Array of DictInfo		IK热词词典配置。
port	Long	9200	实例的私网访问端口号。
kibanaPrivateIPWhitelist	Array of String	["192.168.XX.XX"]	Kibana私网地址访问白名单列表。
esVersion	String	6.3.2_with_X-Pack	实例版本。
kibanaConfiguration	KibanaNodeConfiguration		Kibana节点配置。
dataNode	Boolean	true	实例是否包含数据节点： true：包含 false：不包含
serviceVpc	Boolean	true	实例是否处于Elasticsearch服务VPC下： true：处于 false：不处于
tags	Array of Tag		实例标签。
haveKibana	Boolean	true	实例是否包含Kibana节点： true：包含 false：不包含
dictList	Array of DictInfo		IK词典配置。
extendConfigs	Array of Object	[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]	实例的扩展配置。
status	String	active	实例的状态，支持： active：正常 activating：生效中 inactive：冻结 invalid：失效
instanceId	String	es-cn-3h4k3axh33th9****	实例ID。
zoneInfos	Array of 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	Array of DictInfo		Aliws词典配置。
advancedDedicateMaster	Boolean	true	是否开启新版专有主节点： true：开启 false：不开启
paymentType	String	prepaid	实例的付费类型，支持： prepaid：包年包月 postpaid：按量付费
readWritePolicy	ReadWritePolicy		实例高可用特性的配置信息。
protocol	String	HTTP	实例的访问协议。支持：HTTP和HTTPS。
publicIpWhitelist	Array of 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	Array of String	["0.0.0.0/0"]	私网访问白名单列表。
kibanaIPWhitelist	Array of String	["0.0.0.0/0"]	Kibana公网地址访问白名单列表。
privateNetworkIpWhiteList	Array of String	["0.0.0.0/0"]	实例的私网地址访问白名单列表。
synonymsDicts	Array of DictInfo		实例的同义词词典配置。
haveElasticDataNode	Boolean	false	是否开启弹性数据节点： true：开启 false：不开启
zoneCount	Long	1	实例的可用区个数。
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节点数量。
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****	实例所在的资源组ID。
endTime	Long	4749897600000	包年包月实例最后的失效时间。
instanceId	String	ls-cn-n6w1o5jq****	实例ID。
config	Map		实例配置。
createdAt	String	2018-07-13T03:58:07.253Z	实例创建时间。
networkConfig	Object		网络配置。
type	String	vpc	网络类型，目前仅支持专有网络VPC（Virtual Private Cloud）。
vpcId	String	vpc-abc	专有网络ID。
vsArea	String	cn-hangzhou-*	实例所在的可用区。
vswitchId	String	vsw-def	交换机ID。
zoneInfos	Array		可用区信息。
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	实例的可用区个数。

MasterNodeConfiguration

专有主节点配置信息。

参数名称	类型	示例值	描述
amount	Long	3	专有主节点数量。
spec	String	elasticsearch.sn2ne.large	专有主节点规格。规格信息可通过产品规格查看。
disk	Long	20	专有主节点存储空间，单位：GB。
diskType	String	cloud_essd	专有主节点存储类型，支持： cloud_ssd：SSD云盘 cloud_essd（默认）：ESSD云盘

NetworkConfig

网络配置信息。

参数名称	类型	示例值	描述
type	String	vpc	网络类型，只支持专有网络VPC。
vpcId	String	vpc-bp1xk0naij7jx4ph1****	专有网络ID。
whiteIpGroupList	Array of WhiteIpGroup		IP白名单分组配置。不支持在创建实例时指定IP白名单，需要单独使用API设置不同角色的白名单。
vswitchId	String	vsw-bp1ogpdintii5qvyx****	虚拟交换机ID。
vsArea	String	cn-hangzhou-e	网络所属的可用区ID。

NodeInfo

节点信息。

参数名称	类型	示例值	描述
host	String	172.16.xx.xx	节点IP地址。
hostName	String	es-cn-tl32vdghe0005cd99-data-b-2	节点名称，仅支持7.16版本基于ACK部署的实例。
port	Long	9200	节点端口号。
zoneId	String	cn-hangzhou-b	节点所在可用区ID。

NodeSpec

数据节点配置信息。

参数名称	类型	示例值	描述
diskType	String	cloud_ssd	数据节点存储类型，支持： cloud_ssd：SSD云盘 cloud_essd：ESSD云盘 cloud_efficiency：高效云盘
spec	String	elasticsearch.sn2ne.large	数据节点规格。规格信息可通过产品规格查看。说明在北京、上海、杭州和深圳地域，通过createInstance创建新一代云盘型数据节点的云原生实例时，需指定规格族+后缀`.new`，例如， elasticsearch.sn1ne.large.new。
disk	Integer	20	数据节点存储空间大小，单位为GB。
diskEncryption	Boolean	false	是否为数据节点开启云盘加密： true：开启 false：不开启
performanceLevel	String	PL1	ESSD云盘的性能级别。当数据节点的磁盘类型为ESSD云盘时，必选。支持：PL1、PL2、PL3。

PaymentInfo

包年包月实例的付费详情。

参数名称	类型	示例值	描述
duration	Long	1	购买时间，必选，支持按月和按年购买。
pricingCycle	String	Month	包年包月单位，必选，可选值： Year：年 Month：月
isAutoRenew	Boolean	true	是否开启自动续费设置。可选值： true：开启 false（默认）：不开启
autoRenewDuration	Long	3	自动续费周期，单位：月。isAutoRenew为true时必填，参数值可选范围与售卖页一致。

ReadWritePolicy

高可用特性的参数配置。

参数名称	类型	示例值	描述
writeHa	Boolean	true	是否开启写入高可用特性： true：开启 false：不开启
autoGeneratePk	Boolean	true	无主键时，是否自动生成文档哈希值主键： true（默认）：自动生成主键 false：不会自动生成主键重要 autoGeneratePk不可单独修改，只有在writeHa从false更新为true的时候，同时设置autoGeneratePk才生效。
writePolicy	String	sync	设置临时切换同步和异步高可用。可选值： sync：临时由异步写入高可用切换为同步写入。 async：临时开启同步写入后，恢复异步写入高可用。说明只有在开通高可用，即writeHa为true的情况下，设置此字段才有效。设置此字段时不需要同时传入writeHa字段。

参数名称

类型

示例值

描述

writeHa

Boolean

true

是否开启写入高可用特性：

true：开启
false：不开启

autoGeneratePk

Boolean

true

无主键时，是否自动生成文档哈希值主键：

true（默认）：自动生成主键
false：不会自动生成主键

重要

autoGeneratePk不可单独修改，只有在writeHa从false更新为true的时候，同时设置autoGeneratePk才生效。

writePolicy

String

sync

设置临时切换同步和异步高可用。可选值：

sync：临时由异步写入高可用切换为同步写入。
async：临时开启同步写入后，恢复异步写入高可用。

说明

只有在开通高可用，即writeHa为true的情况下，设置此字段才有效。设置此字段时不需要同时传入writeHa字段。

Tag

标签信息。

参数名称	类型	示例值	描述
tagKey	String	env	标签键。
tagValue	String	dev	标签值。

WarmNodeConfiguration

冷数据节点配置信息。

参数名称	类型	示例值	描述
diskType	String	cloud_efficiency	冷数据节点存储类型，仅支持cloud_efficiency（高效云盘）。
diskEncryption	Boolean	false	是否为冷数据节点开启云盘加密： true：开启 false：不开启
amount	Long	3	冷数据节点数量。
spec	String	elasticsearch.sn2ne.large	冷数据节点规格。规格信息可通过产品规格查看。
disk	Long	500	冷数据节点存储空间大小，单位为GB。
performanceLevel	String	PL1	ESSD云盘的性能级别。当冷数据节点的磁盘类型为ESSD云盘时，必选。支持：PL1、PL2、PL3。

WhiteIpGroup

IP白名单分组。

参数名称	类型	示例值	描述
groupName	String	test_group	IP白名单分组名称。
WhiteIpType	String	PRIVATE_ES	IP白名单的类型，支持： PRIVATE_ES：Elasticsearch私网访问白名单 PUBLIC_ES：Elasticsearch公网访问白名单 PRIVATE_KIBANA：Kibana私网访问白名单 PUBLIC_KIBANA：Kibana公网访问白名单
ips	Array of String	["10.2.xx.xx", "10.3.xx.xx"]	白名单组中的IP白名单列表。

参数名称

类型

示例值

描述

groupName

String

test_group

IP白名单分组名称。

WhiteIpType

String

PRIVATE_ES

IP白名单的类型，支持：

PRIVATE_ES：Elasticsearch私网访问白名单
PUBLIC_ES：Elasticsearch公网访问白名单
PRIVATE_KIBANA：Kibana私网访问白名单
PUBLIC_KIBANA：Kibana公网访问白名单

ips

Array of String

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

白名单组中的IP白名单列表。

ZoneInfo

可用区信息。

参数名称	类型	示例值	描述
status	String	NORMAL	可用区状态，支持： ISOLATION：下线 NORMAL：正常
zoneId	String	cn-hangzhou-b	可用区ID，为可用区的唯一标识。

参数名称

类型

示例值

描述

status

String

NORMAL

可用区状态，支持：

ISOLATION：下线
NORMAL：正常

zoneId

String

cn-hangzhou-b

可用区ID，为可用区的唯一标识。