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

このオペレーションを呼び出して、クラスタ構成を変更できます。

このオペレーションを呼び出すときは、次の点に注意してください。

インスタンスがアクティブ化中、無効、または非アクティブ状態の場合は、構成を変更できません。
クラスタのインデックスにレプリカシャードがなく、クラスタの負荷が過度に高く、大量のデータがクラスタに書き込まれるか、またはクラスタでクエリされる場合、クラスタ構成のアップグレードまたはダウングレード中にクラスタへのアクセスがタイムアウトする可能性があります。クラスタの構成をアップグレードする前に、クライアントにアクセスリトライメカニズムを設定することをお勧めします。これにより、ビジネスへの影響が軽減されます。
一度に変更できるノードタイプは 1 つだけです（データノード、専用マスターノード、コールドデータノード、コーディネーターノード、Kibana ノード、およびエラスティックノード）。
クラスタの健全性と安定性のため、Alibaba Cloud Elasticsearch では、2021 年 5 月以降、1 コア 2 GB インスタンス、専用マスターノード用の 2 コア 2 GB インスタンス、および 7.4 インスタンスの購入はサポートされていません。購入した仕様が販売されなくなったことが確認された場合は、次の操作を実行する必要があります。
- 1 コア 2 GB および 2 コア 2 GB の仕様については、購入ページで利用可能な安定した販売仕様に事前にアップグレードすることをお勧めします。購入ページで利用可能な販売仕様の詳細については、購入ページパラメータをご参照ください。
- クラスタが V7.4 の場合は、V7.10 クラスタを購入し、元のクラスタから V7.10 クラスタにデータを移行します。

詳細については、「クラスタのアップグレード」および「クラスタのダウングレード」をご参照ください。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

PUT /openapi/instances/{InstanceId} HTTP/1.1

リクエストパラメータ

パラメータ	タイプ	位置	必須	例	説明
InstanceId	String	パス	はい	es-cn-n6w1ptcb30009****	インスタンス ID。
clientToken	String	クエリ	いいえ	5A2CFF0E-5718-45B5-9D4D-70B3FF****	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で値が一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。
orderActionType	String	クエリ	いいえ	upgrade	構成変更のタイプ。有効な値： upgrade（デフォルト）：アップグレード downgrade：ダウングレード
	Object	本文	いいえ		リクエストボディパラメータ。
nodeAmount	Integer	本文	いいえ	3	ノード数。
nodeSpec	NodeSpec	本文	いいえ		データノードの構成。
masterConfiguration	MasterNodeConfiguration	本文	いいえ		専用マスターノードの構成。
clientNodeConfiguration	ClientNodeConfiguration	本文	いいえ		コーディネーションノードの構成。
warmNodeConfiguration	WarmNodeConfiguration	本文	いいえ		コールドデータノードを構成します。
kibanaConfiguration	KibanaNodeConfiguration	本文	いいえ		kibana ノードの構成。
elasticDataNodeConfiguration	ElasticDataNodeConfiguration	本文	いいえ		エラスティックノードの構成。
instanceCategory	String	本文	いいえ	advanced	バージョンの種類。有効な値： x-pack：Business Edition インスタンス advanced：Enhanced Edition インスタンス IS：Indexing Service の Enhanced Edition インスタンスを有効にする community：Basic Edition インスタンス説明 OpenStore が有効になっている拡張インスタンスを作成するには、Indexing Service も有効にする必要があります。
force	Boolean	クエリ	いいえ	false	強制的に再起動するかどうか： true：データの暗号化を有効にする false（デフォルト）：いいえ

Elasticsearch でサポートされているノード仕様のリストについては、Alibaba Cloud Elasticsearch の料金情報と製品仕様をご参照ください。

次の例は、リクエストボディパラメータを示しています。

アップグレード

説明

構成をアップグレードする場合、ストレージ容量値、ストレージタイプの構成、ノード数、仕様の CPU コア数、またはメモリ値を減らすことはできません。

ストレージ容量のアップグレード
現在、ストレージ容量をアップグレードできるのは、データノード、コールドデータノード、およびエラスティックデータノードのみです。
コールドデータノードのストレージ容量を 1000 GiB にアップグレードします。
```
{
  "warmNodeConfiguration": {
   "disk": 1000
  }
}
```
ストレージタイプのアップグレード
現在、ストレージタイプをアップグレードできるのは、データノード、エラスティックデータノード、および専用マスターノードのみです。
- 専用マスターノードのストレージタイプを拡張 SSD タイプにアップグレードします。
```
{
  "masterConfiguration": {
    "diskType": "cloud_essd"
  }
}
```
- 専用マスターノードのストレージタイプが拡張 SSD の場合、ノードストレージのパフォーマンスレベルを PL3 にアップグレードします。
  performanceLevel が指定されると、diskType はデフォルトで cloud_essd として設定されます。
  cloud_essd を指定すると、performanceLevel はデフォルトで PL1 になります。
```
	{
	  "masterConfiguration": {
		"performanceLevel": "PL3"
	  }
	}
	
```
アップグレードされたノードの数
現在、データノード、コールドデータノード、エラスティックデータノード、およびコーディネーターノードのみがサポートされています。
データノードのノード数を増やす方法は、他のノードとは異なります。詳細については、次の例をご参照ください。
- データノードの数を 12 に増やします。
```
{
  "nodeAmount": 12
}
```
- 他のタイプのノード（たとえば、コールドデータノード）の数を 12 に増やします。
```
{
  "warmNodeConfiguration": {
    "amount": 12
  }
}
```
ノード仕様のアップグレード
データノードの仕様を 4 コア 32 GB にアップグレードします。
```
{
  "nodeSpec": {
    "spec": "elasticsearch.r5.xlarge"
  }
}
```
同じノードの複数の構成を同時にアップグレードする
同じノードの複数の構成を同時にアップグレードするには、アップグレードされたリソースのリクエストボディを同時に書き込む必要があります。
- コーディネーターノードのノード数を 8 に増やし、仕様を 4 コア 8 GB に増やします。
```
{
  "clientNodeConfiguration": {
    "amount": 8,
    "spec": "elasticsearch.sn1ne.xlarge"
  }
}
```
- データノードの数を 12 に増やし、ストレージタイプを拡張 SSD に変更します。
```
{
  "nodeAmount": 12,
  "nodeSpec": {
    "diskType": "cloud_essd"
  }
}
```
ノードを有効にする
完全なノードリソースを構成する方法の詳細については、createInstance ポートの構成をご参照ください。
- コーディネーションノードを有効にし、コーディネーションノードの構成を設定します。
```
{
  "clientNodeConfiguration": {
    "amount": 5,
    "disk": 20,
    "spec": "elasticsearch.sn1ne.xlarge"
  }
}
```
- エラスティックデータノードを有効にし、エラスティックデータノードの構成を設定します（この構成は中国サイト（aliyun.com）にのみ適用されます）。
```
{
  "elasticNodeConfiguration": {
    "disk": 200,
    "amount": 5,
    "diskType": "cloud_essd",
    "spec": "elasticsearch.sn1ne.xlarge"
  }
}
```
- コールドデータノードを有効にし、コールドデータノードの構成を設定します。
```
{
  "warmNodeConfiguration": {
    "disk": 1000,
    "amount": 3,
    "spec": "elasticsearch.sn1ne.xlarge"
  }
}
```
OpenStore を有効にする（この構成は中国サイト（aliyun.com）にのみ適用されます）
コールドデータノードが有効になっているインスタンス、およびデータノードのストレージタイプが拡張 SSD であるインスタンスは、OpenStore にアップグレードできません。
インスタンスタイプが標準 Business Edition の場合、OpenStore が有効になると、インスタンスタイプは標準 Business Edition から Indexing Service が有効なログ拡張版にアップグレードされます。
- コールドデータノードで OpenStore を開きます。
```
{
  "warmNodeConfiguration": {
    "amount": 5,
    "spec": "openstore.i2g.4xlarge"
  }
}
```
- データは、OpenStore に変換されたノード仕様です。
```
{
  "nodeAmount": 6,
  "nodeSpec": {
    "spec": "openstore.i2g.4xlarge",
    "diskType": "cloud_ssd",
    "disk": 100
  }
}
```
変更方法を指定する
- デフォルトの変更モードはインテリジェント変更で、ブルーグリーン変更（blue_green）またはインプレース変更（normal）として指定されます。
```
{
  "nodeSpec": {
    "spec": "elasticsearch.r5.xlarge"
  },
  "updateType": "blue_green" ## 値を normal に変更します。
}
```
- 強制変更が有効になっています。
```
{
  "nodeSpec": {
    "spec": "elasticsearch.r5.xlarge"
  },
  "force": true
}
```
dryRun インターフェースを使用して構成の事前チェックをアップグレードする
dryRun フィールドをリクエストボディに追加します。
```
{
  "nodeSpec": {
    "spec": "elasticsearch.r5.xlarge"
  },
  "dryRun": true
}
```

ダウングレード

説明

構成をダウングレードする場合、ストレージ容量値、ストレージタイプ、ノード数、仕様の CPU コア数、またはメモリ値をアップグレードすることはできません。

UpdateInstance インターフェースでは、ノード数を減らすことはできません。必要に応じて、ShrinkNode インターフェースを使用してください。

ノードのストレージ容量をダウングレードすることはできません。有効なノードを無効にすることはできません。

強制変更を選択したり、変更タイプを指定したりすることはできません。デフォルトでは、スマート変更が使用されます。

構成をダウングレードする場合は、orderActionType パラメータを Downgrade に設定する必要があります。

複数のリソース構成を同時にダウングレードしたり、dryRun 事前検証を実行したりできます。

ストレージタイプのダウングレード
構成をダウングレードする場合、コールドデータノード、コーディネーターノード、および Kibana ノードのストレージタイプを変更することはできません。
専用マスターノードのストレージタイプを SSD に変更します。
```
{
  "masterConfiguration": {
    "diskType": "cloud_ssd"
  }
}
```
仕様のダウングレード
データノードの仕様を4 コア 32 GB にダウングレードします。
```
{
  "nodeSpec": {
    "spec": "elasticsearch.r5.xlarge"
  }
}
```

レスポンスパラメータ

パラメータ	タイプ	例	説明
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	リクエスト ID。
Result	Object		リクエストの結果。
nodeAmount	Integer	2	データノードの数。
createdAt	String	2018-07-13T03:58:07.253Z	インスタンスが作成された時刻。
status	String	active	インスタンスの状態。有効な値： active：正常 activating：有効化中 inactive：凍結 invalid：無効
paymentType	String	postpaid	インスタンスの課金方法。有効な値： prepaid：サブスクリプション postpaid：従量課金
domain	String	es-cn-abc.elasticsearch.aliyuncs.com	インスタンスのプライベートドメイン名。
description	String	test	インスタンスの名前。
esVersion	String	5.5.3_with_X-Pack	専用 KMS インスタンスのエディション。
instanceId	String	es-cn-abc	インスタンス ID。
nodeSpec	Object		データノードの構成。
spec	String	elasticsearch.sn2ne.xlarge	ノードの仕様。
disk	Integer	40	ノードのストレージ容量。単位：GB。
diskType	String	cloud_ssd	ノードのストレージタイプ。有効な値： cloud_ssd：標準 SSD cloud_efficiency：Ultra ディスク
kibanaConfiguration	Object		Kibana ノードの構成。
spec	String	elasticsearch.n4.small	ノードの仕様。
amount	Integer	1	ノード数。
disk	Integer	20	ノードストレージ容量のサイズ。
diskType	String	cloud_ssd	ノードのストレージタイプ。このパラメータは無視できます。
masterConfiguration	Object		専用マスターノードの構成。
spec	String	elasticsearch.sn2ne.large	ノードの仕様。
amount	Integer	3	ノード数。
disk	Integer	20	ノードのストレージ容量。単位：GB。
diskType	String	cloud_ssd	ノードのストレージタイプ。 cloud_ssd（SSD クラウドディスク）のみがサポートされています。

例

リクエストの例

PUT /openapi/instances/es-cn-n6w1ptcb30009****?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF****&orderActionType=upgrade HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
  "nodeSpec": {
    "spec": "elasticsearch.r5.xlarge"
  }
}

成功レスポンスの例

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : {
    "instanceId" : "es-cn-n6w1ptcb30009****",
    "version" : "5.5.3_with_X-Pack",
    "nodeAmount" : 3,
    "paymentType" : "postpaid",
    "status" : "active",
    "nodeSpec" : {
      "spec" : "elasticsearch.n4.small",
      "disk" : 40,
      "diskType" : "cloud_ssd",
      "diskEncryption" : false
    },
    "createdAt" : "2020-06-28T08:25:52.895Z",
    "zoneCount" : 1,
    "instanceCategory" : "x-pack",
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    }
  },
  "RequestId" : "B5246080-9C30-4B6A-8F8A-8C705405****"
}

サンプルレスポンスの説明

> 戻り値の例では、この記事では戻りデータリストに含まれるパラメータのみが保証され、記載されていないパラメータは参照用です。 プログラムはこれらのパラメータの取得に依存することを強制できません。

エラーコード

エラーコードのリストについては、API エラーセンターにアクセスしてください。