createInstance - Elasticsearch - Alibaba Cloud ドキュメントセンター

createInstance 操作を呼び出して、Elasticsearch インスタンスを作成します。

使用上の注意

Alibaba Cloud Elasticsearch の課金および料金設定基準をよく理解している必要があります。詳細については、「Alibaba Cloud Elasticsearch の料金」をご参照ください。
実名登録が完了している必要があります。
クラスタを作成するときにゾーンを指定する必要はありません。デフォルトでは、クラスタは指定された VPC （仮想プライベートクラウド）と同じゾーンにデプロイされます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作には操作固有のリクエストヘッダーはなく、共通のリクエストヘッダーのみを使用します。詳細については、共通リクエストヘッダーを参照してください。

リクエスト構文

POST /openapi/instances HTTP/1.1

リクエストパラメーター

パラメーター	タイプ	位置	必須	例	説明
clientToken	String	Query	いいえ	5A2CFF0E-5718-45B5-9D4D-70B3FF****	リクエストのべき等性を確保するために使用されます。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。
	Object	Body	いいえ		リクエストパラメーター。
zoneCount	Integer	Body	いいえ	2	クラスタをデプロイするゾーンの数。有効な値：1、2、3。デフォルト値：1。
paymentType	String	Body	いいえ	postpaid	課金方法。有効な値： postpaid：従量課金 prepaid：サブスクリプション
paymentInfo	PaymentInfo	Body	いいえ		クラスタの課金詳細。 paymentType を prepaid に設定した場合、このパラメーターは必須です。
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 文字の長さで、次の文字のうち少なくとも 3 種類を含める必要があります。大文字、小文字、数字、特殊文字。次の特殊文字がサポートされています。! @ # $ % ^ & * ( ) _ + - =
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	インスタンスのタグ値。

説明

Alibaba Cloud Elasticsearch でサポートされているノード仕様のリストについては、「Alibaba Cloud 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": "auto-renewal",
 "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****	DTS インスタンスの 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****"
  }
}

エラーコード

エラーコードのリストについては、「サービスエラーコード」をご参照ください。