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	付費類型。可選值： postpaid：隨用隨付 prepaid：訂用帳戶
paymentInfo	PaymentInfo	Body	否		訂用帳戶執行個體的付費詳情。建立訂用帳戶執行個體時必填。
nodeAmount	Integer	Body	是	3	資料節點個數，取值範圍為2~50。
instanceCategory	String	Body	否	advanced	版本類型： x-pack：建立商業版執行個體，或不開啟Indexing Service和OpenStore的核心增強版執行個體。 IS：建立開啟Indexing Service或OpenStore的核心增強版執行個體。
esAdminPassword	String	Body	是	Es_password	執行個體的訪問密碼。要求包含以下字元中的三種：大寫字母、小寫字母、數字、特殊字元：!@#$%^&*()_+-=，長度為8~32位。
esVersion	String	Body	是	5.5.3_with_X-Pack	執行個體版本。可選值： 8.5.1_with_X-Pack 7.10_with_X-Pack 6.7_with_X-Pack 7.7_with_X-Pack 6.8_with_X-Pack 6.3_with_X-Pack 5.6_with_X-Pack 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****"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。