Gerenciar janelas de manutenção da instância da Apigee

Esta página se aplica a Apigee, mas não a Apigee híbrida.

Consulte a documentação da Apigee Edge.

Esta seção contém procedimentos para localizar e definir janelas de manutenção para recursos da Apigee. Para saber mais sobre como e por que a Apigee realiza a manutenção, consulte a Visão geral da manutenção.

Definir uma janela preferencial para manutenção

Se um recurso já estiver em manutenção ou tiver um evento de manutenção programado, as mudanças feitas na configuração da janela de manutenção (incluindo a mudança do dia/horário, a mudança da ordem de atualização ou a limpeza das configurações) não serão aplicadas ao evento pendente. A manutenção programada será realizada conforme planejado, e as mudanças serão aplicadas apenas a implementações de manutenção futuras.

Se você tiver ativado as notificações de manutenção, a Apigee enviará notificações depois que um recurso tiver sido programado para manutenção, com a data e a hora exatas em que a manutenção está programada para acontecer. A Apigee envia essas notificações com base na ordem das configurações de atualização da janela de manutenção do recurso, da seguinte maneira:

Observação : "Semana 1" e "Semana 2" se referem às fases de lançamento e aos prazos de notificação (1 semana versus 2 semanas). Eles não se referem à primeira ou segunda semana do mês. Por exemplo, um lançamento da "Semana 2" não acontece necessariamente na segunda semana de um mês. Ele acontece uma semana após o lançamento da "Semana 1" para essa versão específica.

  • Se a ordem das configurações de atualização estiver definida como Semana 1, a Apigee enviará notificações de manutenção com pelo menos uma semana de antecedência.
  • Se a ordem das configurações de atualização estiver definida como Semana 2, a Apigee enviará notificações de manutenção com pelo menos duas semanas de antecedência.

Só é possível especificar uma janela de manutenção por instância da Apigee. As solicitações com mais de uma janela de manutenção serão rejeitadas.

Se você quiser definir janelas de manutenção para várias instâncias na mesma organização, garanta que haja pelo menos 12 horas entre as janelas de manutenção para evitar operações de manutenção sobrepostas.

Ao atualizar a janela de manutenção, a janela anterior será substituída.

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"

Em que:

  • A startTime de manutenção é configurada em UTC.
  • maintenanceChannel: o canal de manutenção/ordem de atualização (por exemplo, WEEK1 ou WEEK2).
  • ORGANIZATION_ID é o ID da organização da Apigee.
  • INSTANCE_ID é o ID da instância da Apigee.

Encontrar configurações e programações de manutenção atuais

É possível recuperar as configurações de manutenção atuais e conferir qualquer manutenção futura verificando os campos maintenanceUpdatePolicy e scheduledMaintenance, conforme mostrado no exemplo de API a seguir:

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

Em que:

  • ORGANIZATION_ID é o ID da organização da Apigee.
  • INSTANCE_ID é o ID da instância da Apigee.

Exemplo de saída

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

Limpar as configurações de manutenção

Se você não precisar mais das configurações de manutenção, limpe-as seguindo as instruções abaixo.

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"

Em que:

  • ORGANIZATION_ID é o ID da organização da Apigee.
  • INSTANCE_ID é o ID da instância da Apigee.

Ativar as notificações de manutenção

Antes de ativar as notificações de manutenção, defina uma janela preferencial para manutenção em um recurso.

  1. Noconsole, acesse a página Preferências do usuário > Comunicação. Google Cloud

    Acessar a página Comunicações

  2. Na linha da Apigee, Janela de manutenção, selecione o botão de opção em E-mail para Ativar.

Cada usuário que precisa receber notificações precisa ativar a opção separadamente seguindo as instruções acima.