調用createInstance接口,創建Elasticsearch實例。
注意事項
- 請確保在使用該接口前,已充分了解Elasticsearch產品的收費方式和價格。詳情請參見阿里云Elasticsearch定價。
- 創建實例需要通過實名認證。詳情請參見實名認證。
- 創建實例時不需要指定可用區,實例默認與所選VPC在同一可用區中。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求頭
該接口使用公共請求頭,無特殊請求頭。請參見公共請求參數文檔。
請求語法
POST /openapi/instances HTTP/1.1
請求參數
名稱 |
類型 |
位置 |
是否必選 |
示例值 |
描述 |
clientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** | 用于保證請求的冪等性。由客戶端生成該參數值,要保證在不同請求間唯一,最大不超過64個ASCII字符。 |
Object | Body | 否 | 請求體參數。 |
||
zoneCount | Integer | Body | 否 | 2 | 實例的可用區數量。可選值:1、2、3,默認值:1。 |
paymentType | String | Body | 否 | postpaid | 付費類型??蛇x值:
|
paymentInfo | PaymentInfo | Body | 否 | 包年包月實例的付費詳情。創建包年包月實例時必填。 |
|
nodeAmount | Integer | Body | 是 | 3 | 數據節點個數,取值范圍為2~50。 |
instanceCategory | String | Body | 否 | advanced | 版本類型:
|
esAdminPassword | String | Body | 是 | Es_password | 實例的訪問密碼。要求包含以下字符中的三種:大寫字母、小寫字母、數字、特殊字符:!@#$%^&*()_+-=,長度為8~32位。 |
esVersion | String | Body | 是 | 5.5.3_with_X-Pack | 實例版本。可選值:
說明 以上所列版本不一定包含Elasticsearch實例支持的所有版本,實際支持的版本可調用GetRegionConfiguration接口查看。 |
nodeSpec | NodeSpec | Body | 否 | 數據節點配置。 說明 在北京、上海、杭州和深圳地域,通過createInstance創建新一代云盤型數據節點的實例時,需指定規格族+后綴 .new ,例如, elasticsearch.sn1ne.large.new。 |
|
masterConfiguration | MasterNodeConfiguration | Body | 否 | 專有主節點配置。 說明 在北京、上海、杭州和深圳地域,通過createInstance創建新一代云盤型數據節點的實例時,需指定規格族+后綴 .new ,例如, elasticsearch.sn1ne.large.new。 |
|
warmNodeConfiguration | WarmNodeConfiguration | Body | 否 | 冷數據節點配置。 |
|
clientNodeConfiguration | ClientNodeConfiguration | Body | 否 | 協調節點配置。 |
|
elasticDataNodeConfiguration | ElasticDataNodeConfiguration | Body | 否 | 彈性節點配置。 |
|
kibanaConfiguration | KibanaNodeConfiguration | Body | 否 | Kibana節點配置。 說明 強烈建議開啟Kibana節點。 |
|
networkConfig | NetworkConfig | Body | 是 | 網絡配置。 說明 創建實例時不支持指定IP白名單。 |
|
resourceGroupId | String | Body | 否 | rg-aekzu7tsu4n**** | 實例所屬的資源組ID。 |
description | String | Body | 否 | es | 實例名稱。 |
tags | Array | Body | 否 | 實例標簽組。 |
|
tagKey | String | Body | 否 | KeyTest | 實例的標簽鍵。 |
tagValue | String | Body | 否 | KeyValue | 實例的標簽值。 |
說明
- 阿里云Elasticsearch支持的節點規格列表,請參見阿里云Elasticsearch定價信息和產品規格。
- diskType參數是節點的存儲類型,普通云盤型規格該參數必填,本地盤規格該參數非必填。
請求體參數示例如下:
- 創建通用商業版實例,同時包含冷、熱節點。
{ "description": "xpack-hot-cold", "nodeAmount": 2, "esVersion": "7.10_with_X-Pack", "instanceCategory": "x-pack", "nodeSpec": { "spec": "elasticsearch.sn2ne.xlarge", "disk": 20, "diskType": "cloud_ssd" }, "warmNodeConfiguration": { "spec": "elasticsearch.sn1ne.xlarge", "amount": 3, "diskType": "cloud_efficiency", "disk": 500 }, "networkConfig": { "type": "vpc", "vpcId": "vpc-8vbfu74bmw4m7m84a****", "vswitchId": "vsw-8vbnk6cmurbpump2f****", "vsArea": "cn-zhangjiakou-c" }, "paymentType": "postpaid", "esAdminPassword": "yourPassword", "kibanaConfiguration": { "spec": "elasticsearch.sn1ne.large" } }
- 創建Indexing Service系列實例,只包含熱節點。
{ "description": "is-hot", "nodeAmount": 2, "esVersion": "7.10_with_X-Pack", "instanceCategory": "IS", "nodeSpec": { "spec": "elasticsearch.sn1ne.xlarge", "disk": 20, "diskType": "cloud_ssd" }, "networkConfig": { "type": "vpc", "vpcId": "vpc-8vbfu74bmw4m7m84a****", "vswitchId": "vsw-8vbnk6cmurbpump2f****", "vsArea": "cn-zhangjiakou-c" }, "paymentType": "postpaid", "esAdminPassword": "yourPassword", "kibanaConfiguration": { "spec": "elasticsearch.sn1ne.large" } }
- 創建Indexing Service系列實例,只包含冷節點。
{ "description": "is-cold", "nodeAmount": 2, "esVersion": "7.10_with_X-Pack", "instanceCategory": "IS", "warmNodeConfiguration": { "spec": "group.c6.large.500", "amount": 3, "disk": 300 }, "networkConfig": { "type": "vpc", "vpcId": "vpc-8vbfu74bmw4m7m84a****", "vswitchId": "vsw-8vbnk6cmurbpump2f****", "vsArea": "cn-zhangjiakou-c" }, "paymentType": "postpaid", "esAdminPassword": "yourPassword", "kibanaConfiguration": { "spec": "elasticsearch.sn1ne.large" } }
- 創建Indexing Service系列實例,同時包含冷、熱節點。
{ "description": "is-hot-cold", "nodeAmount": 2, "esVersion": "7.10_with_X-Pack", "instanceCategory": "IS", "nodeSpec": { "spec": "elasticsearch.sn2ne.xlarge", "disk": 50, "diskType": "cloud_ssd" }, "warmNodeConfiguration": { "spec": "group.c6.large.500", "amount": 3, "disk": 300 }, "networkConfig": { "type": "vpc", "vpcId": "vpc-8vbfu74bmw4m7m84a****", "vswitchId": "vsw-8vbnk6cmurbpump2f****", "vsArea": "cn-zhangjiakou-c" }, "paymentType": "postpaid", "esAdminPassword": "yourPassword", "kibanaConfiguration": { "spec": "elasticsearch.sn1ne.large" } }
- 創建Indexing Service系列實例,開啟OpenStore存儲,同時包含冷、熱節點。
{ "description": "os-1", "nodeAmount": 2, "esVersion": "7.10_with_X-Pack", "instanceCategory": "IS", "nodeSpec": { "spec": "elasticsearch.sn2ne.xlarge", "disk": 50, "diskType": "cloud_ssd" }, "warmNodeConfiguration": { "spec": "openstore.i2g.4xlarge", "amount": 3 }, "networkConfig": { "type": "vpc", "vpcId": "vpc-8vbfu74bmw4m7m84a****", "vswitchId": "vsw-8vbnk6cmurbpump2f****", "vsArea": "cn-zhangjiakou-c" }, "paymentType": "postpaid", "esAdminPassword": "yourPassword", "kibanaConfiguration": { "spec": "elasticsearch.sn1ne.large" } }
- 創建Indexing Service系列實例,開啟OpenStore存儲,包含冷熱共享型節點。
{ "description": "os-2", "nodeAmount": 2, "esVersion": "7.10_with_X-Pack", "instanceCategory": "IS", "nodeSpec": { "spec": "openstore.i2g.4xlarge", "disk": 50, "diskType": "cloud_ssd" }, "networkConfig": { "type": "vpc", "vpcId": "vpc-8vbfu74bmw4m7m84a****", "vswitchId": "vsw-8vbnk6cmurbpump2f****", "vsArea": "cn-zhangjiakou-c" }, "paymentType": "postpaid", "esAdminPassword": "yourPassword", "kibanaConfiguration": { "spec": "elasticsearch.sn1ne.large" } }
-
創建通用商業版7.10版本實例,并開啟自動續費。
說明 paymentType設置為prepaid,表示實例為預付費模式。自動續費在paymentInfo參數中設置。{ "description": "自動續費", "nodeAmount": 3, "instanceCategory": "x-pack", "esVersion": "7.10_with_X-Pack", "nodeSpec": { "spec": "elasticsearch.sn2ne.xlarge", "disk": 50, "diskType": "cloud_ssd" }, "kibanaConfiguration": { "spec": "elasticsearch.sn1ne.large" }, "networkConfig": { "type": "vpc", "vpcId": "vpc-8vbfu74bmw4m7m84a****", "vswitchId": "vsw-8vbnk6cmurbpump2f****", "vsArea": "cn-zhangjiakou-c" }, "paymentType": "prepaid", "paymentInfo": { "duration": 1, "pricingCycle": "Month", "isAutoRenew": true, "autoRenewDuration": 1 }, "esAdminPassword": "yourPassword" }
返回參數
名稱 |
類型 |
示例值 |
描述 |
RequestId |
String |
838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3 |
請求ID。 |
Result |
object |
返回結果。 |
|
└instanceId |
string |
es-is-0u2ecp69tt**** |
實例ID。 |
示例
請求示例
POST /openapi/instances?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
"description": "xpack-hot-cold",
"nodeAmount": 2,
"esVersion": "7.10_with_X-Pack",
"instanceCategory": "x-pack",
"nodeSpec": {
"spec": "elasticsearch.sn2ne.xlarge",
"disk": 20,
"diskType": "cloud_ssd"
},
"warmNodeConfiguration": {
"spec": "elasticsearch.sn1ne.xlarge",
"amount": 3,
"diskType": "cloud_efficiency",
"disk": 500
},
"networkConfig": {
"type": "vpc",
"vpcId": "vpc-8vbfu74bmw4m7m84a****",
"vswitchId": "vsw-8vbnk6cmurbpump2f****",
"vsArea": "cn-zhangjiakou-c"
},
"paymentType": "postpaid",
"esAdminPassword": "yourPassword",
"kibanaConfiguration": {
"spec": "elasticsearch.sn1ne.large"
}
}
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<createInstanceResponse>
<RequestId>838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3</RequestId>
<Result>
<instanceId>es-is-0u2ecp69tt****</instanceId>
</Result>
</createInstanceResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3",
"Result" : {
"instanceId" : "es-is-0u2ecp69tt****"
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助?