Saiba neste documento como recriar uma
instância
da Apigee sem causar inatividade no gerenciamento de APIs ou perda de dados.
Introdução
As instâncias da Apigee criadas antes de 25 de janeiro de 2022 não têm espaço de endereço IP
suficiente para que as cargas de trabalho da Apigee sejam escalonadas para processar o aumento no tráfego de APIs e/ou
para que você adicione mais de 10 ambientes em uma instância.
Em 24 de janeiro de 2022, a Apigee introduziu
uma melhoria para resolver esse problema. A melhoria reduz o intervalo de IPs necessário
para fazer peering da sua rede VPC com a Apigee e usa
IPs públicos de uso
privado (PUPI) para que as cargas de trabalho sejam escalonadas para limites maiores.
O que é preciso fazer
Se você tiver uma instância da Apigee criada antes de 25 de janeiro de 2022, a Apigee recomenda
que ela seja substituída por uma nova instância, conforme explicado neste documento. Se você não
recriar a instância antiga, poderá ter problemas de escalonamento, e o número de ambientes
que podem ser adicionados a uma instância continuará limitado a 10. Além disso, a instância pode parar de receber atualizações regulares, o que afetará os serviços da API.
Determinar a data de criação de uma instância
Para determinar a data de criação de uma instância da Apigee, faça o seguinte:
Liste os detalhes de todas as instâncias da Apigee na sua organização:
Em cada instância, verifique o valor do campo createdAt decodificando o carimbo de data/hora Unix
para saber a data.
Se uma instância foi criada em 25 de janeiro de 2022 ou após essa data, não será necessário
fazer mais nada.
Se uma instância foi criada antes de 25 de janeiro de 2022, recomendamos que você a
substitua, conforme explicado neste documento.
Sobre o procedimento de recriação
Para recriar uma instância com inatividade zero e sem perda de dados, primeiro é necessário criar uma nova
instância em uma nova região (expandida) e direcionar o tráfego de APIs para essa nova instância. Em seguida, é possível
drenar, excluir e recriar a instância atual na mesma região que a
excluída.
A Apigee forneceu um conjunto de scripts que executam todas as etapas necessárias para recriar e configurar
uma instância. Vamos fornecer um link para os scripts mais adiante neste documento.
Pré-requisitos
Antes de iniciar as etapas de recriação da instância:
Você precisa saber como a instância da Apigee foi criada. As etapas
para recriar a instância dependem do que você sabe sobre como a instância original foi
configurada.
Você precisa ter o direito de provisionar a Apigee em pelo menos duas
regiões. Se você não tiver certeza se tem direitos suficientes, siga as etapas para criar uma instância em uma
nova região. Se você não tiver o direito adequado, a tentativa vai falhar com um erro de limite. Nesse caso,
entre em contato com o suporte da Apigee para conseguir uma exceção temporária e aumentar
o limite da sua região. Se você já tem direito a duas ou mais regiões, recomendamos entrar em contato
para pedir uma exceção temporária e evitar executar sua carga de trabalho de produção
com uma instância reduzida durante o processo de recriação.
É preciso ter espaço no projeto para intervalos de IP adicionais de blocos /22 e
/28 para criar a nova instância. Consulte também
Dimensionamento de rede.
É possível liberar esses intervalos quando a região adicional é excluída depois de concluir a recriação da instância. O bloco
/22 pode ser configurado por você. É possível escolher qual bloco /28 a Apigee vai usar ou,
se você não escolher, ele será atribuído automaticamente pela Apigee de qualquer bloco disponível.
Recriar a instância
A Apigee forneceu um conjunto de scripts que executam todas as etapas necessárias para recriar uma instância.
O sentido norte se refere ao tráfego de APIs de clientes externos ou internos para a Apigee por um balanceador de
carga. Quando uma instância é excluída e recriada, o endereço IP e o ID do anexo de serviço
Private
Service Connect (PSC) no sentido norte daquela instância mudam para a nova instância.
Os scripts fornecidos reconfiguram o back-end do balanceador
de carga para você. Se o roteamento de rede
da instância foi configurado com um grupo gerenciado
de instâncias (MIG), um script fornecido recria o MIG que redireciona o tráfego para o endpoint da Apigee
e anexa o MIG como um back-end ao serviço de back-end atual. Se o roteamento foi configurado
com o Private Service Connect (PSC), um script recria o grupo de endpoints da rede (NEG) para o
anexo de endpoints de serviço da Apigee e anexa o novo NEG como back-end ao serviço de
back-end atual.
Não será necessário alterar os registros de nome do host em nenhum
grupo de ambiente
associado à instância antiga.
Alterações no sentido sul
O sentido sul se refere ao tráfego de APIs da Apigee para os serviços de destino do seu proxy de API.
Quando uma instância é excluída e recriada, todos os endereços IP NAT dedicados no sentido sul são
liberados. Portanto, é necessário reservar e ativar novos endereços IP para seu NAT e reconfigurar
firewalls/lista de permissões nos endpoints de destino. Um dos scripts fornecidos processa
essa reconfiguração NAT para você, 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-03 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."]]
