移動

• リクエスト
• レスポンス
• 例

デフォルト期間でのメンテナンス・モードの開始

put

/admin/v1/maintenance/start

メンテナンス・モードを開始します。MicroTxコーディネータの複数のレプリカをデプロイした場合は、各レプリカでこのAPIを実行します。進行中のトランザクションが完了するデフォルトの時間バッファは5分です。開始する前に、必ず`/admin/v1/maintenance/clear` RESTコールを実行して、データ・ストア内の既存のキャッシュ済メンテナンス・データをクリアしてください。メンテナンス・モードを開始すると、MicroTxトランザクション・コーディネータの各レプリカ内のすべての新規リクエストのトランザクション・ログがキャッシュとデータ・ストアの両方に保存されます。

リクエスト

この操作にはリクエスト・パラメータはありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK、メンテナンス・モード

202レスポンス

受け入れられ、メンテナンス・プロセスが開始されました

500レスポンス

InternalServerError

先頭に戻る

例

cURLコマンド

次の例では、cURLを使用してRESTリソースに対するPUTリクエストを発行することによって、進行中のトランザクションが完了するためにデフォルトの5分間の時間バッファを使用してメンテナンス・モードを開始する方法を示しています。cURLの詳細は、「cURLの使用」を参照してください

コマンドは1行で入力してください。この例では、読みやすくするために改行を使用しています。

curl -X PUT 
     -H "Authorization:Bearer $OTMM_COOKIE"
     https://192.0.2.1:8080/admin/v1/maintenance/start

• OTMM_COOKIEは、前に認証cookieを格納した変数の名前です。認証cookieの取得および変数への格納の詳細は、認証を参照してください。

• 192.0.2.1:8080は、RESTエンドポイントURLの例です。この値をRESTエンドポイントURLに変更して、ご使用の環境のIstioイングレス・ゲートウェイにアクセスします。ご使用のサイトのRESTエンドポイントURLを確認する方法の詳細は、リクエストの送信を参照してください。

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
     "message": "in maintenance mode"
}

先頭に戻る