推定再起動時間 - Elasticsearch - Alibaba Cloud ドキュメントセンター

Elasticsearch クラスターの再起動に必要な推定時間を取得します。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

POST /openapi/instances/{InstanceId}/estimated-time/restart-time HTTP/1.1

リクエストパラメーター

パラメーター	タイプ	位置	必須	例	説明
InstanceId	String	Path	はい	es-cn-n6w1o1x0w001c****	インスタンス ID。
force	ブール値	Query	いいえ	false	クラスターを強制的に再起動するかどうかを指定します。デフォルト値: false。
	String	Body	いいえ	{ "restartType":"nodeIp", "nodes": ["172.16.xx.xx"], "blueGreenDep":true }	再起動パラメーター情報を指定します。

リクエスト本文

リクエスト本文で以下のパラメーターを構成して、再起動に関する情報を指定できます。

パラメーター	タイプ	必須	例	説明
restartType	String	いいえ	instance	再起動タイプ。サポートされているタイプ: instance: インスタンスを再起動します。これはデフォルト値です。 nodeIp: ノードが再起動されます。
nodes	List<String>	いいえ	["127.0.0.1"]	ノードが再起動されたときに、ターゲットノードの IP アドレスリストを選択します。
blueGreenDep	ブール値	いいえ	false	ノードの再起動時にブルーグリーン変更を実行するかどうかを指定します。デフォルト値: false
batch	double	いいえ	25.0	インスタンス再起動の同時実行性。このパラメーターのデフォルト値は、クラスター内のノードの総数で 1 を割った値です。
batchUnit	String	いいえ	percent	バッチの単位。デフォルト値: percent。

説明

restartType パラメーターを instance に設定した場合、blueGreenDep パラメーターを構成する必要はありません。
- force パラメーターを true に設定した場合、batch パラメーターを 0 より大きく 100 以下の値に設定する必要があります。そうしないと、システムは RestartBatchValueError エラーを報告します。
- force パラメーターを false に設定した場合、batch パラメーターのデフォルト値は 0 です。 batch パラメーターを 0 以外の値に設定すると、システムは NormalRestartNotSupportBatch エラーを報告します。
restartType パラメーターを nodeIp に設定した場合、batch パラメーターを構成する必要はありません。
- nodes パラメーターが構成されていない場合、システムはパラメーター構成エラーを報告します。
- blueGreenDep パラメーターを true に設定すると、システムはブルーグリーン再起動を実行します。 blueGreenDep パラメーターを false に設定すると、システムは通常の再起動を実行します。

サンプル文:


{
    "restartType":"nodeIp",
    "nodes": ["172.16.xx.xx"],
    "blueGreenDep":true
}

レスポンスパラメーター

パラメーター	タイプ	例	説明
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	リクエスト ID。
Result	Object		返された結果。
unit	String	second	単位。
value	Long	50	推定再起動時間。

例

サンプルリクエスト

POST /openapi/instances/es-cn-n6w1o1x0w001c****/estimated-time/restart-time?force=true HTTP/1.1
共通リクエストヘッダー

サンプルの成功レスポンス

JSON 形式

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

{
  "Result" : {
    "unit" : "second",
    "value" : 4200
  },
  "RequestId" : "7ACE8751-DD1B-40DB-A253-9080CA58****"
}

HTTP ステータスコード

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