通用資料結構 - Elasticsearch

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	網路類型，目前僅支援Virtual Private Cloud（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	網路類型，只支援Virtual Private Cloud。
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，為可用性區域的唯一標識。