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

Elasticsearch クラスターのメンテナンスウィンドウを有効化および変更します。

この操作を呼び出す前に、次の点に注意してください。

メンテナンスが実行される前に、システムは Alibaba Cloud アカウントにリストされている連絡先に SMS メッセージとメールを送信します。
インスタンスメンテナンスの当日、メンテナンスプロセス全体の安定性を確保するために、インスタンスはメンテナンスウィンドウになる前にアクティブ状態になります。この場合でも、クラスターにアクセスして、パフォーマンス監視などのクエリ操作を実行できます。ただし、クラスターの再起動や構成のアップグレードなどの変更操作は実行できません。
使用可能なメンテナンスウィンドウ内でインスタンス接続が切断される場合があります。アプリケーションに再接続メカニズムがあることを確認してください。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

POST /openapi/instances/{InstanceId}/actions/modify-maintaintime HTTP/1.1

リクエストパラメーター

パラメーター	タイプ	場所	必須	例	説明
InstanceId	String	Path	はい	es-cn-n6w1o1x0w001c****	インスタンスの ID。
ClientToken	String	Query	いいえ	5A2CFF0E-5718-45B5-9D4D-70B3FF****	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。
	String	Body	いいえ	{ "openMaintainTime": true, "maintainStartTime": "03:00Z", "maintainEndTime": "04:00Z" }	リクエストボディパラメーター。詳細については、「RequestBody」セクションをご参照ください。

RequestBody

メンテナンスウィンドウ情報を指定するには、RequestBody パラメーターで次のパラメーターも指定する必要があります。

パラメーター	タイプ	必須	例	説明
maintainStartTime	String	いいえ	02:00Z	メンテナンスウィンドウの開始時刻。 HH:mmZ 形式で時刻を指定します。時刻は UTC である必要があります。
maintainEndTime	String	いいえ	06:00Z	メンテナンスウィンドウの終了時刻。 HH:mmZ 形式で時刻を指定します。時刻は UTC で表示する必要があります。
openMaintainTime	boolean	はい	true	メンテナンスウィンドウ機能を有効にするかどうかを指定します。 true のみがサポートされており、機能が有効になっていることを示します。

例：


{
    "openMaintainTime": true,
    "maintainStartTime": "03:00Z",
    "maintainEndTime": "04:00Z"
}

レスポンスパラメーター

パラメーター	タイプ	例	説明
Result	Boolean	true	返された結果。
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	リクエストの ID。

例

リクエストの例

POST /openapi/instances/es-cn-n6w1o1x0w001c****/actions/modify-maintaintime?ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
    "openMaintainTime": true,
    "maintainStartTime": "03:00Z",
    "maintainEndTime": "04:00Z"
}

成功レスポンスの例

JSON 形式

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

{
  "Result" : true,
  "RequestId" : "8577468C-D13F-4980-BD71-977F9D82****"
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。