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

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

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

Definir uma janela preferencial para manutenção

Se você fizer alterações na configuração da janela de manutenção enquanto o recurso estiver em manutenção ou programado para manutenção, as mudanças não entrarão em vigor imediatamente. Essas alterações são refletidas nos eventos de manutenção futuros.

Se você ativou as notificações de manutenção, a Apigee envia notificações depois que um recurso é 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:

  • Se a ordem das configurações de atualização estiver definida como "Semana 1", o 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", o 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 do 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 elas para evitar operações de manutenção sobrepostas.

Ao atualizar a janela de manutenção, a 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 manutenção startTime é configurada em UTC.
  • ORGANIZATION_ID é o ID da sua organização da Apigee.
  • INSTANCE_ID é o ID da instância da Apigee.

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

Para recuperar suas configurações de manutenção atuais e conferir as próximas manutenções, verifique 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 sua 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
        }
      }
    ]
  }
}

Limpar configurações de manutenção

Se você não precisar mais das configurações de manutenção, siga as instruções abaixo para limpar.

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 sua 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. No console do Google Cloud , acesse a página Preferências do usuário > Comunicação.

    Acessar Comunicações

  2. Na linha 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 aceitar separadamente seguindo as instruções acima.