バージョン: 3.5

メンテナンスウィンドウのクエリ

特定のメンテナンスウィンドウをクエリします。

リクエスト

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

パス変数

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

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

レスポンス

サンプルレスポンス

{
  "code": 20000,
  "data": {
    "window": {
      "window_id": "w-1a2b3c",
      "cluster_id": "c-9f8e7d",
      "window_type": "WEEKLY",
      "day_of_week": "SUNDAY",
      "day_of_month": 0,
      "start_time": "02:00",
      "end_time": "05:00",
      "timezone": "America/Los_Angeles",
      "enabled": true
    }
  }
}

レスポンス要素

パラメーター	例	タイプ	説明
code	20000	Integer	エラーコード。返されたエラーコードが `20000` の場合、リクエストは成功しました。他のエラーコードが返された場合、リクエストは失敗しました。
data	-	Object	API 呼び出しの結果。データオブジェクトは一部の API アクションでは返されない場合があります。ウィンドウ情報のオブジェクトを返します。
data.window	-	Array	ウィンドウ情報の配列
data.window.window_id	`w-1a2b3c`	String	ウィンドウの ID。
data.window.cluster_id	-	String	クラスターの ID。
data.window.window_type	`"WEEKLY"`	STRING	メンテナンスウィンドウの繰り返し周期。
data.window.day_of_week	`"SUNDAY"`	STRING	`window_type` が `WEEKLY` の場合の曜日。
data.window.day_of_month	`15`	Integer	`window_type` が `MONTHLY` の場合の日にち。
data.window.start_time	`"01:00"`	STRING	ウィンドウの開始時刻。
data.window.end_time	`"04:00"`	STRING	ウィンドウの終了時刻。
data.window.timezone	`"America/Los_Angeles"`	STRING	IANA ゾーン名。
data.window.enabled	`true`	BOOLEAN	ウィンドウが有効かどうか。

リクエスト​

パス変数​

ヘッダー パラメーター​

レスポンス​

サンプルレスポンス​

レスポンス要素​