設定維護期間

本頁說明如何為 Cloud Data Fusion 執行個體定義維護期間。

維護時間窗格適用於 Cloud Data Fusion 6.8.0 以上版本的執行個體。

關於維護期間

Cloud Data Fusion 中的維護時間是指您允許系統執行維護作業的時間範圍，可降低在使用率高峰期間服務中斷的風險。請在非尖峰時段或活動較少的時間安排維護期間，以盡量減少對 Cloud Data Fusion 執行個體和管道執行作業的影響。

您可以設定維護期間，控管執行個體何時執行維護作業：

  • 如果已定義維護期間，Cloud Data Fusion 會在指定期間內執行維護作業。
  • 如果未定義維護期間，系統可隨時執行維護作業。

關於維護作業

為確保系統安全和法規遵循，Cloud Data Fusion 會定期執行維護作業。這些作業包括套用重要更新和安全性修補程式，以減輕漏洞風險並保護使用者資料。排定維護期間可確保更新能有效率地套用，維持系統完整性，並盡量減少執行個體和管道執行作業的中斷時間。

  • 設定維護期間時，您必須每週至少分配 12 小時來進行維護作業。每個時間範圍必須介於 4 到 12 小時之間。

  • 在維護期間，某些作業可能會受到影響。建議您在非用量高峰時段設定維護期間。維護作業可能會對 Cloud Data Fusion 造成以下影響：

    • Cloud Data Fusion Studio 介面可能暫時無法使用。
    • 管道執行可能會受到影響，導致失敗。
    • Cloud Data Fusion 服務可能會暫時停機，導致 API 呼叫失敗。
    • 在維護時段內，執行個體可能最多會在 1 小時內無法完全運作。建議您在管道未執行或未排定執行時，設定維護時段。

在建立執行個體時指定維護期間

主控台

如要在建立執行個體時設定維護時段，請按照下列步驟操作：

  1. 前往 Cloud Data Fusion 的「Instances」(執行個體) 頁面，然後按一下「Create instance」(建立執行個體)。

    建立執行個體

  2. 輸入「Instance name」(執行個體名稱)和「Edition」(版本)。如要進一步瞭解各個欄位，請參閱「建立執行個體」。
  3. 展開「Advanced options」(進階選項) 區段。
  4. 展開「維護作業」專區，然後按照下列步驟操作：
    1. 勾選「啟用維護期間」核取方塊。
    2. 在「開始時間」欄位中，輸入支援格式的時間。
    3. 在「時區」TimeZone清單中選取時區。
    4. 在「Days」和「Length」清單中，選取星期幾和時間長度。如要進一步瞭解這些設定，請參閱「關於維護作業」。
    5. 按一下 [建立]。

詳情請參閱「設定維護期間時間和重複規則 (RRULE)」。

REST API

  1. 使用 instance.create API 設定 Instance：
{
  "name": string,
  "description": string,
  …
  …
  "maintenancePolicy": {
    "maintenanceWindow": {
      "recurringTimeWindow": {
        "window": {
            "startTime": "START_TIME",
            "endTime": "END_TIME"
        },
        "recurrence": "MAINTENANCE_RECURRENCE"
      }
    },
  }
}

更改下列內容：

  • START_TIME：時間區間開始時間，採用 RFC 3339 格式。
  • END_TIME：時間視窗結束時間，採用 RFC 3339 格式。

  • MAINTENANCE_RECURRENCE：維護期間重複的 RRULE。Cloud Data Fusion 僅支援下列格式：

    • FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA 或 BYDAY=SU,MO,TU,WE,TH,FR,SA,MO;FREQ=WEEKLY。這會指定在所選日期的週週重複執行視窗，從 startTime 開始，並持續指定的時間長度。

詳情請參閱「設定維護期間時間和重複規則 (RRULE)」。

以下範例會建立執行個體，其維護期間為每週星期六和星期日上午 10 點至下午 4 點 (世界標準時間)，詳情請參閱 instances API 說明文件。

// POST https://datafusion.googleapis.com/v1/projects/example-project/locations/us-central1/instances?instanceID=example-instance

{
  "maintenancePolicy": {
      "maintenanceWindow": {
          "recurringTimeWindow": {
              "window": {
                  "startTime": "2024-01-01T10:00:00Z",
                  "endTime": "2024-01-01T16:00:00Z",
              },
              "recurrence": "FREQ=WEEKLY;BYDAY=SA,SU"
          }
      },
  }
}

gcloud

您可以在使用 gcloud beta data-fusion instances create 指令建立執行個體時，指定維護期間。

下列參數必須為維護期間定義：

  • --maintenance-window-start 會設定排除期間的開始時間。
  • --maintenance-window-end 會設定視窗的結束時間。
  • --maintenance-window-recurrence 會為維護期間的重複設定 RRULE。
gcloud beta data-fusion instances create INSTANCE_NAME \
    --project=PROJECT_NAME \
    --location=LOCATION \
    --maintenance-window-start=START_TIME \
    --maintenance-window-end=END_TIME \
    --maintenance-window-recurrence=MAINTENANCE_RECURRENCE

更改下列內容：

  • INSTANCE_NAME：執行個體的名稱。
  • PROJECT_NAME：專案名稱。
  • LOCATION：執行個體所在的區域名稱。
  • START_TIME：使用日期/時間輸入格式表示的視窗開始時間。系統只會使用當天指定的時間，而忽略指定的日期。
  • END_TIME：窗格結束時間，格式為 日期/時間輸入格式。系統只會使用當天指定的時間，而忽略指定的日期。指定的日期和時間必須晚於開始時間。

  • MAINTENANCE_RECURRENCE：維護期間重複的 RRULE。Cloud Data Fusion 僅支援下列格式：

    • FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA 或 BYDAY=SU,MO,TU,WE,TH,FR,SA,MO;FREQ=WEEKLY。這會指定在所選日期的週期性回溯期，從 --maintenance-window-start 時間開始，並持續指定的時間長度。

詳情請參閱「設定維護期間時間和重複規則 (RRULE)」。

下列指令會建立執行個體，其維護期間為每週星期六和星期日的下午 12 點至下午 6 點 (世界標準時間)，為期六小時。

gcloud beta data-fusion instances create example-instance \
    --project='example-project' \
    --location='us-east1' \
    --maintenance-window-start='2024-01-01T12:00:00Z' \
    --maintenance-window-end='2024-01-01T18:00:00Z' \
    --maintenance-window-recurrence='FREQ=WEEKLY;BYDAY=SA,SU'

更新執行個體的維護期間

主控台

如要在Google Cloud 主控台中更新現有例項的維護時間，請按照下列步驟操作：

  1. 前往 Cloud Data Fusion 的「Instances」(執行個體) 頁面。

    前往「Instances」(執行個體)

  2. 按一下執行個體名稱，查看執行個體詳細資料。

  3. 在「Instance details」頁面中，前往「Maintenance window」欄位，然後按一下「Edit」。

  4. 維護時段欄位會在編輯模式中開啟。視需要更新值：

    1. 勾選「啟用維護期間」核取方塊。
    2. 在「開始時間」欄位中，輸入支援格式的時間。
    3. 在「時區」TimeZone清單中選取時區。
    4. 在「Days」和「Length」清單中，選取星期幾和時間長度。如要進一步瞭解這些設定，請參閱「關於維護作業」。

  5. 按一下 [儲存]。

詳情請參閱「設定維護期間時間和重複規則 (RRULE)」。

REST API

如為現有執行個體，請使用 instances.patch API 要求更新維護時間窗。這會覆寫現有的維護期間設定 (如有)。否則，系統會如要求主體所述，設定新的設定。

請按照以下方式建構 API 要求：

  1. 在 updateMask 參數中指定 maintenance_policy 遮罩。
  2. 在要求主體中，在維護政策設定中指定維護期間：
{
  "maintenancePolicy": {
    "maintenanceWindow": {
        "recurringTimeWindow": {
          "window": {
              "startTime": "START_TIME",
              "endTime": "END_TIME"
          },
          "recurrence": "MAINTENANCE_RECURRENCE"
        }
    },
  }
}

詳情請參閱「設定維護期間時間和重複規則 (RRULE)」。

以下範例會更新執行個體的維護政策設定，每週在週五、週六和週日上午 11 點至下午 3 點 (世界標準時間) 之間提供四小時的維護時段。

// PATCH https://datafusion.googleapis.com/v1/projects/example-project/locations/us-central1/instances/example-instance?updateMask=maintenance_policy

{
"maintenancePolicy": {
  "maintenanceWindow": {
    "recurringTimeWindow": {
      "window": {
          "startTime": "2024-01-01T11:00:00Z",
          "endTime": "2024-01-01T15:00:00Z",
        },
      "recurrence": "FREQ=WEEKLY;BYDAY=FR,SA,SU"
    }
  },
}
}

gcloud

您可以使用 gcloud beta data-fusion instances update 指令更新執行個體的維護期間。

下列參數必須為維護期間定義：

  • --maintenance-window-start 會設定排除期間的開始時間。
  • --maintenance-window-end 會設定視窗的結束時間。
  • --maintenance-window-recurrence 會為維護期間的重複設定 RRULE。
gcloud beta data-fusion instances update INSTANCE_NAME \
    --project=PROJECT_NAME \
    --location=LOCATION \
    --maintenance-window-start=START_TIME \
    --maintenance-window-end=END_TIME \
    --maintenance-window-recurrence=MAINTENANCE_RECURRENCE

更改下列內容：

  • INSTANCE_NAME：執行個體的名稱。
  • PROJECT_NAME：專案名稱。
  • LOCATION：執行個體所在的區域名稱。
  • START_TIME：使用日期/時間輸入格式表示的視窗開始時間。系統只會使用當天指定的時間，而忽略指定的日期。
  • END_TIME：窗格結束時間，格式為 日期/時間輸入格式。系統只會使用當天指定的時間，而忽略指定的日期。指定的日期和時間必須晚於開始時間。

  • MAINTENANCE_RECURRENCE：維護期間重複的 RRULE。Cloud Data Fusion 僅支援下列格式：

    • FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA 或 BYDAY=SU,MO,TU,WE,TH,FR,SA,MO;FREQ=WEEKLY。這會指定在所選日期的週期性回溯期，從 --maintenance-window-start 時間開始，並持續指定的時間長度。

下列指令會更新執行個體 example-instance，維護時段為每週六和週日中午 12 點至下午 6 點 (世界標準時間) 的六小時。

gcloud beta data-fusion instances update example-instance \
    --project='example-project' \
    --location='us-east1' \
    --maintenance-window-start='2024-01-01T12:00:00Z' \
    --maintenance-window-end='2024-01-01T18:00:00Z' \
    --maintenance-window-recurrence='FREQ=WEEKLY;BYDAY=SA,SU'

設定維護期間時間和重複規則 (RRULE)

設定維護期間的開始和結束時間時，系統會忽略提供的時間戳記日期元件。系統只會考量一天中的時間，以及開始時間和結束時間之間的時間長度。時間會以世界標準時間儲存，但您可以使用世界標準時間或時區偏移值，在使用 REST API 或 gcloud CLI 排定維護時段時。

設定週期時，請注意 RRULE 會依照世界標準時間，因此如果您的時區不同，請據此調整。舉例來說，如果您的時區為 PDT (UTC-7)，且希望維護期間自當地時間星期三 21:00 開始 (對應於星期四 4:00)，請在 RRULE 的 BYDAY 選項中指定 TH，而非 WE。

移除執行個體的維護期間

主控台

如要在Google Cloud 控制台中移除現有執行個體的維護期間，請按照下列步驟操作：

  1. 前往 Cloud Data Fusion 的「Instances」(執行個體) 頁面。

    前往「Instances」(執行個體)

  2. 按一下執行個體名稱，查看執行個體詳細資料。

  3. 在「Instance details」頁面中，前往「Maintenance window」欄位，然後按一下「Edit」。

  4. 如要從執行個體移除維護期間，請取消勾選「啟用維護期間」核取方塊。

  5. 按一下 [儲存]。

REST API

如要從執行個體移除維護期間，請在要求主體中傳遞空白的維護政策物件。

// PATCH https://datafusion.googleapis.com/v1/projects/example-project/locations/us-central1/instances/example-instance?updateMask=maintenance_policy

{
    "maintenancePolicy": {}
}

gcloud

如要從執行個體移除維護期間，請使用帶有 --clear-maintenance-window 標記的 gcloud beta data-fusion instances update 指令。

gcloud beta data-fusion instances update INSTANCE_NAME \
    --project=PROJECT_NAME \
    --location=LOCATION \
    --clear-maintenance-window

更改下列內容：

  • INSTANCE_NAME：執行個體的名稱。
  • PROJECT_NAME：專案名稱。
  • LOCATION：執行個體所在的區域名稱。

後續步驟