ClientNodeConfiguration
協調節點配置信息。
參數名稱 |
類型 |
示例值 |
描述 |
---|---|---|---|
diskType |
String |
cloud_efficiency |
協調節點存儲類型,僅支持cloud_efficiency(高效云盤)。 |
amount |
Long |
3 |
協調節點數量。 |
spec |
String |
elasticsearch.sn2ne.large |
協調節點規格。規格信息可通過產品規格查看。 |
disk |
Long |
20 |
協調節點存儲空間大小,單位:GB。 |
DictInfo
詞典配置信息。
參數名稱 |
類型 |
示例值 |
描述 |
---|---|---|---|
type |
String |
ALI_WS |
詞典文件類型,支持:
|
sourceType |
String |
OSS |
詞典文件來源類型,支持:
|
fileSize |
Long |
2782602 |
詞典文件大小,單位:Byte。 |
name |
String |
aliws_ext_dict.txt |
詞典文件名稱。要求如下:
|
ElasticDataNodeConfiguration
彈性數據節點配置信息。
參數名稱 |
類型 |
示例值 |
描述 |
---|---|---|---|
diskType |
String |
cloud_ssd |
彈性節點存儲類型,支持:
|
diskEncryption |
Boolean |
false |
是否為彈性節點開啟云盤加密:
|
amount |
Long |
3 |
彈性節點數量。 |
spec |
String |
elasticsearch.sn2ne.large |
彈性節點規格。規格信息可通過產品規格查看。 |
disk |
Long |
20 |
彈性節點存儲空間大小,單位為GB。 |
performanceLevel |
String |
PL1 |
ESSD云盤的性能級別。當彈性節點的磁盤類型為ESSD云盤時,必選。支持:PL1、PL2、PL3。 |
Elasticsearch
Elasticsearchsh實例配置信息。
參數名稱 |
類型 |
示例值 |
描述 |
---|---|---|---|
masterConfiguration |
專有主節點配置。 |
||
resourceGroupId |
String |
rg-aekzvowej3i**** |
實例所屬的資源組ID。 |
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 |
Kibana節點配置。 |
||
dataNode |
Boolean |
true |
實例是否包含數據節點:
|
serviceVpc |
Boolean |
true |
實例是否處于Elasticsearch服務VPC下:
|
tags |
Array of Tag |
實例標簽。 |
|
haveKibana |
Boolean |
true |
實例是否包含Kibana節點:
|
dictList |
Array of DictInfo |
IK詞典配置。 |
|
extendConfigs |
Array of Object |
[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }] |
實例的擴展配置。 |
status |
String |
active |
實例的狀態,支持:
|
instanceId |
String |
es-cn-3h4k3axh33th9**** |
實例ID。 |
zoneInfos |
Array of ZoneInfo |
實例所在的可用區信息。 |
|
kibanaProtocol |
String |
HTTPS |
Kibana訪問協議,支持HTTP和HTTPS。 |
enableKibanaPrivateNetwork |
Boolean |
false |
是否開啟Kibana私網訪問:
|
kibanaDomain |
String |
es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com |
Kibana公網訪問地址。 |
nodeSpec |
數據節點配置。 |
||
warmNode |
Boolean |
false |
是否開啟冷數據節點:
|
warmNodeConfiguration |
冷數據節點配置。 |
||
domain |
String |
es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com |
Elasticsearch實例的私網訪問地址。 |
haveClientNode |
Boolean |
false |
是否開啟協調節點:
|
clientNodeConfiguration |
協調節點配置。 |
||
description |
String |
es-cn-abc |
實例名稱。 |
endTime |
Long |
5 |
實例到期時間,單位為年。按量付費實例默認為100年。 |
enablePublic |
Boolean |
true |
是否開啟實例的公網地址:
|
aliwsDicts |
Array of DictInfo |
Aliws詞典配置。 |
|
advancedDedicateMaster |
Boolean |
true |
是否開啟新版專有主節點:
|
paymentType |
String |
prepaid |
實例的付費類型,支持:
|
readWritePolicy |
實例高可用特性的配置信息。 |
||
protocol |
String |
HTTP |
實例的訪問協議。支持:HTTP和HTTPS。 |
publicIpWhitelist |
Array of String |
["0.0.0.0/0"] |
實例的公網地址訪問白名單列表。 |
kibanaPort |
Long |
5601 |
Kibana公網訪問端口號。 |
enableKibanaPublicNetwork |
Boolean |
true |
是否開啟Kibana的公網訪問:
|
networkConfig |
實例網絡配置。 |
||
productType |
String |
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 |
是否開啟彈性數據節點:
|
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 |
可用區狀態。支持:
|
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 |
可用區狀態。支持:
|
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 |
實例版本。支持:
|
dataNode |
Boolean |
true |
是否啟用數據節點,必須設置為true。 |
nodeSpec |
Object |
數據節點配置。 |
|
disk |
Long |
50 |
節點磁盤大小。 |
diskType |
String |
cloud_ssd |
節點磁盤類型。 |
spec |
String |
logstash.n4.small |
節點規格。 |
paymentType |
String |
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 |
專有主節點存儲類型,支持:
|
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 |
數據節點存儲類型,支持:
|
spec |
String |
elasticsearch.sn2ne.large |
數據節點規格。規格信息可通過產品規格查看。 說明
在北京、上海、杭州和深圳地域,通過createInstance創建新一代云盤型數據節點的云原生實例時,需指定規格族+后綴 |
disk |
Integer |
20 |
數據節點存儲空間大小,單位為GB。 |
diskEncryption |
Boolean |
false |
是否為數據節點開啟云盤加密:
|
performanceLevel |
String |
PL1 |
ESSD云盤的性能級別。當數據節點的磁盤類型為ESSD云盤時,必選。支持:PL1、PL2、PL3。 |
PaymentInfo
包年包月實例的付費詳情。
參數名稱 |
類型 |
示例值 |
描述 |
---|---|---|---|
duration |
Long |
1 |
購買時間,必選,支持按月和按年購買。 |
pricingCycle |
String |
Month |
包年包月單位,必選,可選值:
|
isAutoRenew |
Boolean |
true |
是否開啟自動續費設置。可選值:
|
autoRenewDuration |
Long |
3 |
自動續費周期,單位:月。isAutoRenew為true時必填,參數值可選范圍與售賣頁一致。 |
ReadWritePolicy
高可用特性的參數配置。
參數名稱 |
類型 |
示例值 |
描述 |
---|---|---|---|
writeHa |
Boolean |
true |
是否開啟寫入高可用特性:
|
autoGeneratePk |
Boolean |
true |
無主鍵時,是否自動生成文檔哈希值主鍵:
重要 autoGeneratePk不可單獨修改,只有在writeHa從false更新為true的時候,同時設置autoGeneratePk才生效。 |
writePolicy |
String |
sync |
設置臨時切換同步和異步高可用。可選值:
說明
只有在開通高可用,即writeHa為true的情況下,設置此字段才有效。設置此字段時不需要同時傳入writeHa字段。 |
Tag
標簽信息。
參數名稱 |
類型 |
示例值 |
描述 |
---|---|---|---|
tagKey |
String |
env |
標簽鍵。 |
tagValue |
String |
dev |
標簽值。 |
WarmNodeConfiguration
冷數據節點配置信息。
參數名稱 |
類型 |
示例值 |
描述 |
---|---|---|---|
diskType |
String |
cloud_efficiency |
冷數據節點存儲類型,僅支持cloud_efficiency(高效云盤)。 |
diskEncryption |
Boolean |
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白名單的類型,支持:
|
ips |
Array of String |
["10.2.xx.xx", "10.3.xx.xx"] |
白名單組中的IP白名單列表。 |
ZoneInfo
可用區信息。
參數名稱 |
類型 |
示例值 |
描述 |
---|---|---|---|
status |
String |
NORMAL |
可用區狀態,支持:
|
zoneId |
String |
cn-hangzhou-b |
可用區ID,為可用區的唯一標識。 |