Este documento explica como recriar uma instância do Apigee sem incorrer em tempo de inatividade da gestão de APIs nem perda de dados.
Introdução
As instâncias do Apigee criadas antes de 25 de janeiro de 2022 não têm espaço de endereço do protocolo de Internet (IP) suficiente para permitir que as cargas de trabalho do Apigee sejam dimensionadas para processar o aumento do tráfego da API e/ou para permitir que adicione mais de 10 ambientes a uma instância.
A 24 de janeiro de 2022, o Apigee introduziu
uma melhoria para resolver este problema. O melhoramento reduz o intervalo de IPs necessário para estabelecer uma relação de interligação entre a sua rede VPC e o Apigee, e usa IPs públicos usados de forma privada (PUPI) para permitir que as cargas de trabalho sejam dimensionadas para limites mais elevados.
O que tem de fazer
Se tiver uma instância do Apigee criada antes de 25 de janeiro de 2022, a Apigee recomenda que a substitua por uma nova instância, conforme explicado neste documento. Se não
recriar a instância mais antiga, pode ter problemas de escalabilidade e o número de ambientes
que pode adicionar a uma instância vai continuar a estar limitado a 10. Além disso, a sua instância pode deixar de receber atualizações regulares, o que afeta os serviços de API.
Determinar a data de criação de uma instância
Para determinar a data de criação de uma instância do Apigee:
Liste os detalhes de todas as instâncias do Apigee na sua organização:
Para cada instância, verifique o valor do campo createdAt descodificando a indicação de tempo de época Unix
para obter a data.
Se uma instância foi criada a 25 de janeiro de 2022 ou após essa data, não tem de fazer mais nada para essa instância.
Se uma instância foi criada antes de 25 de janeiro de 2022, recomendamos que substitua a instância, conforme abordado neste documento.
Acerca do procedimento de recriação
Para recriar uma instância sem tempo de inatividade e sem perda de dados, primeiro tem de criar uma nova instância numa nova região (expandida) e direcionar o tráfego da API para essa nova instância. Em seguida, pode
esvaziar a instância existente, eliminá-la e recriá-la na mesma região que a
instância eliminada.
A Apigee forneceu um conjunto de scripts que executam todos os passos necessários para recriar e configurar uma instância. Disponibilizamos um link para os scripts mais adiante neste documento.
Pré-requisitos
Antes de começar os passos de recriação da instância:
Tem de saber como a instância do Apigee foi criada. Os passos
para recriar a instância dependem de saber detalhes sobre a forma como a instância original foi
configurada.
Tem de ter o direito de aprovisionar o Apigee em, pelo menos, duas regiões. Se não tiver a certeza de que tem autorização suficiente, siga os passos para criar uma instância numa
nova região. Se não tiver a autorização adequada, a tentativa falha com um erro de limite. Nesse caso,
contacte o apoio técnico do Apigee para receber uma exceção temporária para aumentar
o limite da sua região. Se já tiver direito a duas ou mais regiões, recomendamos que
contacte-nos para receber a exceção temporária e evitar executar a carga de trabalho de produção
com uma instância reduzida durante o processo de recriação.
Tem de ter espaço no seu projeto para intervalos de IP adicionais de /22 e blocos de /28 para criar a nova instância. Consulte também
Dimensionamento da rede.
Pode libertar estes intervalos quando a região adicional for eliminada após a recriação da instância estar concluída. Tenha em atenção que o bloco
/22 é configurável por si. Pode escolher o bloco /28 que o Apigee vai usar ou, se não escolher, é atribuído automaticamente pelo Apigee a partir de qualquer bloco disponível.
Recriar a instância
O Apigee forneceu um conjunto de scripts que executam todos os passos necessários para recriar uma instância.
O tráfego de saída refere-se ao tráfego de API de clientes externos ou internos para o Apigee através de um equilibrador de carga. Quando uma instância é eliminada e recriada, o endereço IP de saída e o ID da associação do serviço Private
Service Connect (PSC) da instância mudam para a nova instância.
Os scripts fornecidos reconfiguram o back-end do balanceador de carga por si. Se o encaminhamento de rede da instância tiver sido configurado com um grupo de instâncias geridas (MIG), um script fornecido recria o MIG que encaminha o tráfego para o ponto final do Apigee e anexa o MIG como um back-end ao serviço de back-end existente. Se o encaminhamento tiver sido configurado com o Private Service Connect (PSC), um script recria o grupo de pontos finais da rede (NEG) para a associação do ponto final do serviço do Apigee e associa o novo NEG como um back-end ao serviço de back-end existente.
Tenha em atenção que não tem de alterar os registos de nome do anfitrião em nenhum
grupo de ambientes
associado à instância antiga.
Alterações no sentido sul
Southbound refere-se ao tráfego de API do Apigee para os serviços de destino do proxy de API.
Quando uma instância é eliminada e recriada, todos os endereços IP NAT de saída dedicados são
libertados. Por isso, tem de reservar e ativar novos endereços IP para o NAT e reconfigurar as firewalls/listas de autorizações nos seus pontos finais de destino. Um dos scripts fornecidos processa esta reconfiguração de NAT por si, se necessário.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-09-04 UTC."],[[["\u003cp\u003eThis document guides Apigee users with instances created before January 25, 2022, to replace them due to IP scaling limitations and to ensure continued updates and full API service functionality.\u003c/p\u003e\n"],["\u003cp\u003eRecreating an older Apigee instance is recommended to resolve scaling issues and environment limitations, otherwise, there is potential to experience scaling issues or limitations on the number of environments.\u003c/p\u003e\n"],["\u003cp\u003eThe recreation process involves creating a new instance in an expanded region, directing traffic to it, draining the old instance, and then recreating it in the original region, which enables zero downtime and no data loss.\u003c/p\u003e\n"],["\u003cp\u003eApigee provides a set of scripts to automate the instance recreation and reconfiguration process, including managing load balancers and, if needed, southbound NAT IP addresses.\u003c/p\u003e\n"],["\u003cp\u003ePrior to starting the recreation, users must be familiar with their instance's initial configuration, have entitlements to provision Apigee in multiple regions, and ensure sufficient IP ranges are available.\u003c/p\u003e\n"]]],[],null,["# Recreating an Apigee instance with zero downtime\n\n*This page\napplies to **Apigee** , but not to **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n| **Important:** This topic only applies to organizations that were created with VPC peering enabled. See also [Apigee networking options](/apigee/docs/api-platform/get-started/networking-options).\n\n\nThis document explains how to recreate an Apigee\n[instance](/apigee/docs/api-platform/get-started/basic-concepts#instance)\nwithout incurring API management downtime or data loss.\n\nIntroduction\n------------\n\n\nApigee instances created before January 25, 2022, do not have sufficient internet protocol (IP)\naddress space to allow Apigee workloads to scale to handle increasing API traffic and/or\nto allow you to add more than 10 environments to an instance.\n\n\nOn January 24, 2022, Apigee [introduced\nan enhancement](/apigee/docs/release-notes#January_24_2022) to address this problem. The enhancement reduces the IP range required\nto peer your VPC network with Apigee and uses\n[privately\nused public IPs](https://cloud.google.com/architecture/configuring-privately-used-public-ips-for-GKE) (PUPI) to allow workloads to scale to higher limits.\n\nWhat you need to do\n-------------------\n\n\nIf you have an Apigee instance that was created before January 25, 2022, Apigee recommends\nthat you replace it with a new instance, as explained in this document. If you do not\nrecreate the older instance, you may experience scaling issues and the number of environments\nyou can add to an instance will continue to be limited to 10. Also, your instance may stop\ngetting regular updates which will impact the API services.\n\nDetermining an instance's creation date\n---------------------------------------\n\n\nTo determine the creation date of an Apigee instance:\n\n1. List details for all of the Apigee instances in your organization: \n\n AUTH=\"Authorization: Bearer $(gcloud auth print-access-token)\"\n\n curl -i -X GET -H \"$AUTH\" \\\n \"https://apigee.googleapis.com/v1/organizations/\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e/instances\"\n\n\n Where:\n - `AUTH` is the Authentication header with a bearer token. Be sure the default project for `gcloud` is set to the `PROJECT_ID`.\n - `PROJECT_ID` is the Cloud project ID that you created when you provisioned Apigee.\n\n\n Sample output: \n\n ```verilog\n {\n \"instances\": [\n {\n \"name\": \"us-west1\",\n \"location\": \"us-west1\",\n \"host\": \"10.117.200.2\",\n \"port\": \"443\",\n \"createdAt\": \"1642698826000\",\n \"lastModifiedAt\": \"1655745226000\",\n \"diskEncryptionKeyName\": \"projects/myproject/locations/us-west1/keyRings/my-key-ring/cryptoKeys/my-key\",\n \"state\": \"ACTIVE\",\n \"peeringCidrRange\": \"SLASH_22\",\n \"runtimeVersion\": \"1-8-0-apigee-33\",\n \"ipRange\": \"10.117.200.0/22,10.81.174.192/28\",\n \"consumerAcceptList\": [\n \"myproject\"\n ],\n \"serviceAttachment\": \"projects/z11f28c6f3104980e-tp/regions/us-west1/serviceAttachments/apigee-us-west1-lbko\"\n }\n ]\n }\n ```\n2. For each instance, check the value of the `createdAt` field by decoding the Unix timestamp to get the date.\n - If an instance was created on or after January 25, 2022, then you do not have to do anything further for that instance.\n - If an instance was created before January 25, 2022, we recommend you replace the instance, as discussed in this document.\n\nAbout the recreation procedure\n------------------------------\n\n\nTo recreate an instance with zero downtime and no data loss, you need to first create a new\ninstance in a new (expanded) region and direct API traffic to that new instance. Then, you\ncan drain down the existing instance, delete it, and recreate it in the same region as the\none you deleted.\n\n\nApigee has provided a set of scripts that perform all of the required steps to recreate and configure\nan instance. We provide a link to the scripts later in this document.\n\nPrerequisites\n-------------\n\n\nBefore you begin the instance recreation steps:\n\n- You must be familiar with how the Apigee instance was created in the first place. The steps for recreating the instance depend on you knowing details about how the original instance was configured.\n- You must be entitled to provision Apigee in at least two regions. If you aren't sure if you have sufficient entitlement, follow the steps to create an instance in a new region. If you do not have the proper entitlement the attempt will fail with a limit error. In that case, contact Apigee support to get a temporary exception to increase your region limit. If you are already entitled for two or more regions, we recommend you reach out to get the temporary exception to avoid running your production workload with a reduced instance during the recreation process. The process of recreating an instance includes deleting the old instance. If you do not follow the step to create a new instance in an expanded region, you will incur downtime and runtime data loss, including KVMs, cache data, quota data, and KMS data. Therefore, region expansion is mandatory to recreate an instance without downtime or data loss.\n- You must have room in your project for additional IP ranges of **/22** and **/28** blocks to create the new instance. See also [Network sizing](https://cloud.google.com/apigee/docs/api-platform/system-administration/peering-ranges#sizing). You can release these ranges when the additional region is deleted after instance recreation is complete. Note that the **/22** block is configurable by you. You can choose which **/28** block Apigee will use, or if you don't choose, it is auto-assigned by Apigee from any available block.\n\nRecreating the instance\n-----------------------\n\n\nApigee has provided a set of scripts that perform all of the required steps to recreate an instance.\n\n1. Be sure you have met the [prerequisites](#prerequisites).\n2. [Download the scripts](https://github.com/apigee/apigee-x-pupi-migration) from GitHub.\n3. Follow the steps in the Git repository's [README](https://github.com/apigee/apigee-x-pupi-migration#readme) file to create the new instance.\n4. Reconfigure the northbound and southbound connections to point to the new Apigee instance. See [About northbound changes](#about-northbound-changes) and [About southbound changes](#about-southbound-changes).\n\n### About northbound changes\n\n\nNorthbound refers to API traffic from external or internal clients to Apigee through a load\nbalancer. When an instance is deleted and recreated, the northbound IP address and\n[Private\nService Connect](/apigee/docs/api-platform/system-administration/northbound-networking-psc) (PSC) service attachment ID of the instance will change for the new instance.\n\n\nThe provided scripts reconfigure the load balancer's\nbackend for you. If the instance's [network routing](/apigee/docs/api-platform/get-started/install-cli#configure-routing)\nwas configured with a managed instance\ngroup (MIG), a provided script recreates the MIG that proxies traffic to the Apigee endpoint,\nand attaches the MIG as a backend to the existing backend service. If routing was configured\nwith private service connect (PSC), a script recreates the network endpoint group (NEG) to\nApigee's service endpoint attachment and attaches the new NEG as a backend to the existing\nbackend service.\n\nNote that you will not have to change the hostname records in any\n[environment groups](/apigee/docs/api-platform/fundamentals/environments-overview)\nassociated with the old instance.\n\n### Southbound changes\n\n\nSouthbound refers to API traffic from Apigee to your API proxy target services.\n\n\n| **Note:** Southbound changes are only needed if you used NAT IPs for Apigee instances, as described in [Provisioning\n| NAT IPs](/apigee/docs/api-platform/security/nat-provisioning).\n\n\nWhen an instance is deleted and recreated, any dedicated southbound NAT IP addresses will be\nreleased. So, you must reserve and activate new IP addresses for your NAT and reconfigure\nyour firewalls/allowlisting on your target endpoints. One of the provided scripts handles\nthis NAT reconfiguration for you, if needed."]]
