管理 Apigee 執行個體維護期間

本頁內容適用於 Apigee，但不適用於 Apigee Hybrid。

查看 Apigee Edge 說明文件。

本節提供程序，說明如何尋找及設定 Apigee 資源的維護期間。如要進一步瞭解 Apigee 執行維護作業的方式和原因，請參閱「維護作業總覽」。

設定偏好的維護期間

如果資源正在進行維護作業或已排定維護事件，您對維護期間設定所做的任何變更 (包括變更日期/時間、變更更新順序或清除設定) 都不會套用至待處理的事件。預定維護作業會照常進行，變更只會套用至日後的維護作業。

如果您已選擇接收維護通知，Apigee 會在資源排定維護作業後傳送通知，告知您維護作業的確切日期和時間。Apigee 會根據資源維護期間的更新設定順序傳送這些通知，如下所示：

注意：「第 1 週」和「第 2 週」是指推出階段和通知提前時間 (1 週與 2 週)。不是指當月的第一或第二個日曆週。舉例來說，「第 2 週」的推出時間不一定會是日曆月份的第二週。也就是在該特定版本「第 1 週」推出後的一週。

  • 如果更新設定的順序設為第 1 週，Apigee 會至少提前一週傳送維護通知。
  • 如果更新設定的順序設為第 2 週，Apigee 至少會在兩週前傳送維護通知。

每個 Apigee 執行個體只能指定一個維護期間。如果要求包含多個維護期間，系統會拒絕。

如要為同一機構中的多個執行個體設定維護期間，請確保維護期間之間至少間隔 12 小時，以免維護作業重疊。

更新維護期間時，系統會覆寫先前的維護期間。

AUTH="Authorization: Bearer $(gcloud auth print-access-token)"
curl -X PATCH \
  -H "$AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "maintenanceUpdatePolicy": {
      "maintenanceWindows": [
        {
          "day": "SUNDAY",
          "startTime": {
            "hours": 23
          }
        }
      ],
      "maintenanceChannel": "WEEK1"
    }
  }' \
  "https://apigee.googleapis.com/v1/organizations/ORGANIZATION_ID/instances/INSTANCE_ID?updateMask=maintenanceUpdatePolicy.maintenanceWindows,maintenanceUpdatePolicy.maintenanceChannel"

其中：

  • 維護作業 startTime 是以世界標準時間設定。
  • maintenanceChannel：維護管道/更新設定順序 (例如 WEEK1 或 WEEK2)。
  • ORGANIZATION_ID 是您的 Apigee 機構 ID。
  • INSTANCE_ID 是您的 Apigee 執行個體 ID。

查看現有的維護設定和維護時間表

您可以擷取目前的維護設定，並查看 maintenanceUpdatePolicy 和 scheduledMaintenance 欄位，瞭解即將進行的維護作業，如下列 API 範例所示：

AUTH="Authorization: Bearer $(gcloud auth print-access-token)"
curl -H "$AUTH" \
  "https://apigee.googleapis.com/v1/organizations/ORGANIZATION_ID/instances/INSTANCE_ID"

其中：

  • ORGANIZATION_ID 是您的 Apigee 機構 ID。
  • INSTANCE_ID 是您的 Apigee 執行個體 ID。

輸出範例

{
  ...
  "scheduledMaintenance": {
    "startTime": "2025-01-28T23:00:00Z"
  },
  "maintenanceUpdatePolicy": {
    "maintenanceWindows": [
      {
        "day": "SUNDAY",
        "startTime": {
          "hours": 23
        }
      }
    ],
    "maintenanceChannel": "WEEK1"
  }
}

清除維護設定

如果不再需要維護設定，請按照下列指示清除。

AUTH="Authorization: Bearer $(gcloud auth print-access-token)"
curl -X PATCH \
  -H "$AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "maintenanceUpdatePolicy": null
  }' \
  "https://apigee.googleapis.com/v1/organizations/ORGANIZATION_ID/instances/INSTANCE_ID?updateMask=maintenanceUpdatePolicy"

其中：

  • ORGANIZATION_ID 是您的 Apigee 機構 ID。
  • INSTANCE_ID 是您的 Apigee 執行個體 ID。

選擇接收維護通知

選擇啟用維護通知前，請務必先在資源上 設定偏好的維護期間。

  1. 在 Google Cloud 控制台，前往「使用者偏好設定」>「通訊」頁面。

    前往「通訊」頁面

  2. 在「Apigee，維護期間」列中，選取「電子郵件」下方的圓形按鈕，將其設為「開啟」。

如要接收通知，每位使用者都必須按照上述說明個別啟用這項功能。