管理 Apigee 实例维护窗口

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

本部分介绍如何查找和设置 Apigee 资源的维护期。如需详细了解 Apigee 如何执行维护以及为什么要执行维护，请参阅维护概览。

设置首选维护期

如果您在资源正在维护或已安排维护时更改维护窗口设置，则更改不会立即生效。这些更改会反映在未来的维护事件中。

如果您已选择接收维护通知，则 Apigee 会在资源安排维护后向您发送通知，其中包含安排维护的确切日期和时间。Apigee 会根据资源的更新维护窗口顺序设置发送这些通知，如下所示：

  • 如果更新顺序设置设定为“第 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 以世界协调时间 (UTC) 进行配置。
  • 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
        }
      }
    ]
  }
}

清除维护设置

如果您不再需要维护设置，可以按照以下说明清除这些设置。

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，维护期所对应的行中，选择电子邮件下方的单选按钮以开启电子邮件功能。

每个需要接收通知的用户必须按照上述说明分别选择接收通知。