バージョン: 4.x

メンテナンスウィンドウの作成

セキュリティパッチ用のメンテナンスウィンドウを作成します。PhoenixAI は、メンテナンスウィンドウ中にパッチを自動的に適用します。

リクエスト

基本情報
HTTP URL	`https://cloud-api.celerdata.com/api/1.0/clusters/:cluster_id/maintenance-windows`
HTTP メソッド	POST
頻度	600/分

パス変数

パラメーター	例	必須	タイプ	説明
cluster_id	4ae48a3f-f840-46fa-b0e7-0709a220fa40	はい	String	クラスターの ID。 PhoenixAI Cloud コンソールにサインインし、クラスターの `概要` ページの `クラスタープロパティ` セクションに移動してクラスター ID を取得できます。

:<variable_name> は、Postman などの Web 開発ツールにおける URL パス変数を示します。上記の URL パスにおける :cluster_id は、一時停止したいクラスターの ID を示します。ただし、curl などの他のツールを使用する場合は、curl コマンド内で :cluster_id を実際のクラスター ID に手動で置き換える必要があります。

ヘッダーパラメーター

パラメーター	例	必須	タイプ	説明
Authorization	Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY	はい	String	PhoenixAI Cloud API にアクセスするために使用されるアクセストークン。形式: `Bearer <access_token>`。

アクセストークンの取得を参照してください。

リクエストボディ

{
  "window_type": "WEEKLY",
  "day_of_week": "SUNDAY",
  "start_time": "02:00",
  "end_time": "05:00",
  "timezone": "America/Los_Angeles",
  "enabled": true
}

パラメーター	例	必須	タイプ	説明
window_type	`"WEEKLY"`	はい	STRING	メンテナンスウィンドウの繰り返し周期。有効な値: `WEEKLY` および `MONTHLY`。クラスタ内の複数のウィンドウは、同じタイプでなければなりません。
day_of_week	`"SUNDAY"`	はい	STRING	`window_type` が `WEEKLY` に設定されている場合の曜日。有効な値: `SUNDAY`、`MONDAY`、`TUESDAY`、`WEDNESDAY`、`THURSDAY`、`FRIDAY`、`SATURDAY`。
day_of_month	`1`	はい	INT	`window_type` が `MONTHLY` に設定されている場合の日にち。値の範囲: [1, 31]。
start_time	`"02:00"`	はい	STRING	ウィンドウの開始時刻。形式: `HH:mm`、24 時間表記。時刻の値は必ずゼロ埋めした形式で指定してください（例: `"2:00"` ではなく `"02:00"`）。そうしないと、Terraform が継続的な差分を報告する可能性があります。各ウィンドウには少なくとも 2 時間を割り当てる必要があります。ウィンドウが深夜をまたぐことはできません。
end_time	`"05:00"`	はい	STRING	ウィンドウの終了時刻。形式: `HH:mm`、24 時間表記。時刻の値は必ずゼロ埋めした形式で指定してください（例: `"2:00"` ではなく `"02:00"`）。そうしないと、Terraform が継続的な差分を報告する可能性があります。各ウィンドウには少なくとも 2 時間を割り当てる必要があります。ウィンドウが深夜をまたぐことはできません。
timezone	`"America/Los_Angeles"`	はい	STRING	IANA ゾーン名。`+08:00` のような生のオフセットは拒否されます。
enabled	`true`	はい	BOOLEAN	ウィンドウを有効にするかどうか。

警告

同一のウィンドウを設定するリクエスト（新規作成または既存の更新による）は拒否されます。

レスポンス

サンプルレスポンス

{
    "code": 20000,
    "data": { 
        "window_id": "w-1a2b3c"
        }
}

レスポンス要素

パラメーター	例	タイプ	説明
code	20000	Integer	エラーコード。返されたエラーコードが `20000` の場合、リクエストは成功しました。他のエラーコードが返された場合、リクエストは失敗しました。
data	-	Object	API 呼び出しの結果。データオブジェクトは一部の API アクションでは返されない場合があります。ウィンドウ情報のオブジェクトを返します。
data.window_id	`w-1a2b3c`	String	ウィンドウの ID。

リクエスト​

パス変数​

ヘッダー パラメーター​

リクエストボディ​

レスポンス​

サンプルレスポンス​

レスポンス要素​