Uma instância é uma máquina
virtual em que o projeto da API e os serviços relacionados são armazenados. As instâncias correspondem a regiões.
Normalmente, você começa com uma única instância e adiciona novas instâncias à medida que sua organização se expande
em mais regiões. Esta seção explica como:
Para criar uma nova instância, use a API Instances ou a IU da Apigee. Cada instância requer o seguinte:
a própria chave de criptografia de disco para a rede. O Google recomenda que você
também crie um keyring separado para a nova instância. Para mais informações, consulte Sobre as chaves de criptografia da Apigee.
seus próprios intervalos CIDR /22 e /28 não sobrepostos para peering de rede. Os intervalos não podem ser
compartilhados entre instâncias.
Apigee no console do Cloud
Para criar uma nova instância na Apigee no console do Cloud:
Selecione Gerenciamento > Instâncias. O painel Instâncias exibe uma lista das instâncias.
Clique em Criar. Pode haver um atraso enquanto a IU determina se a organização tem os direitos necessários para criar uma nova instância.
A página Criar nova instância é exibida.
Insira detalhes sobre a nova instância nos campos:
Campo
Obrigatório
Descrição
Runtime hosting location
Obrigatório
Selecione a região em que você quer criar a nova instância. Não é possível criar uma nova instância em uma região que já tenha uma. Para mais informações sobre como trabalhar com várias regiões, consulte Como usar várias regiões.
Name
Obrigatório
Insira o código da nova instância.
O valor padrão é o nome da região de hospedagem do ambiente de execução que você selecionou, mas é possível alterá-lo para qualquer nome significativo que quiser, desde que você siga as regras de nomenclatura:
Comprimento mínimo de 2.
Tamanho máximo de 32.
Use apenas letras minúsculas, números e hífens (seguindo o padrão /^[a-z0-9\-]+$/).
precisa começar com uma letra, não tenha dígitos iniciais ou hífens.
Precisa terminar com um número ou letra, não tem hifens no final.
Precisa ser único em toda a organização.
IP range allocation
Obrigatório
Especifique como você quer alocar um intervalo de IP. Escolha entre estas opções:
Automático (recomendado): a Apigee seleciona um intervalo CIDR disponível com um tamanho de prefixo de /22. Não é necessária nenhuma ação da sua parte.
Personalizado: em casos de uso avançados, talvez seja necessário especificar exatamente qual
intervalo de IP você quer que a Apigee use. Para esses casos, você especifica um intervalo de IP personalizado e precisa ter o tamanho de /22. O intervalo precisa estar disponível como parte de uma conexão particular entre seu projeto e a Apigee.
Disk encryption key
Obrigatório
Em Chave de criptografia de disco, escolha uma chave de criptografia gerenciada pelo cliente. Se uma chave já existir, você poderá selecioná-la. O assistente lista todas as chaves no mesmo local que a região de hospedagem do ambiente de execução em todos os keyrings. Se não existir uma chave ou se você não quiser usar uma atual, crie uma nova chave a partir do assistente. Para criar uma chave:
Clique em Criar chave.
Selecione um conjunto de chaves ou, se não existir, ative Criar conjunto de chaves e insira um nome e escolha um local para ele. Os nomes de keyrings podem conter letras, números, sublinhados (_) e hífens (-). Os keyrings não podem ser renomeados ou excluídos.
Clique em Continuar.
Criar uma chave. Digite um nome e um nível de proteção.
Os nomes das chaves podem conter letras, números, sublinhados (_) e hífens (-). As chaves não podem ser renomeadas ou excluídas. Para o nível de proteção, Software é uma boa escolha. Esse é o mesmo padrão usado pelo Cloud KMS. No entanto, é possível alterá-lo se quiser.
Clique em Continuar e revise suas seleções.
Clique em Criar.
Clique em Conceder para conceder à conta de serviço permissão para criptografar/descriptografar com
a chave selecionada.
Environments
Opcional
Selecione os ambientes que você quer anexar a esta instância Para fazer isso, clique na
lista suspensa Ambientes e marque as caixas de seleção ao lado dos
ambientes que você quer anexar. É possível fazer isso em quantos ambientes você quiser. Em seguida, clique em OK.
Os ambientes de todas as instâncias contam para o número total de ambientes que você pode alocar. Saiba mais em
Sobre ambientes e grupos de ambientes:
Clique em Adicionar projeto aceito para selecionar um ou mais projetos do Cloud. Os
projetos selecionados podem se conectar de maneira privada ao anexo do serviço da instância.
Por padrão, o projeto associado à organização da Apigee é incluído nessa
lista.
Enable logging
Opcional
Clique no botão Ativar geração de registros para ativar os registros de acesso de entrada do Cloud Logging na instância.
Esse recurso permite visualizar os registros gerados por gateways de entrada
na sua infraestrutura da Apigee, como um balanceador de carga de aplicativo externo ou um gateway do Anthos,
para ajudar na solução de problemas de chamadas de API da Apigee.
Selecione um código de resposta HTTP na caixa código de resposta para atuar como um filtro
dos registros de acesso de entrada.
Se quiser incluir todos os registros, independentemente do código de resposta HTTP, selecione None (all HTTP responses).
Para criar um filtro personalizado, selecione Custom e insira o filtro neste formato:
status_code > XX && status code <= YY
Exemplo:
status_code >= 500 && status_code < 504
Se sua organização não puder criar uma nova instância, entre em contato com a Apigee Sales.
Clique em Criar.
A Apigee inicia uma operação de longa duração que pode levar 20 minutos ou mais para ser concluída. Quando ela for concluída, a nova instância aparecerá na lista de instâncias da interface Instâncias.
Ao criar um ambiente usando a interface da Apigee no console do Google Cloud, você tem a opção de atribuí-lo
a uma instância atual. Para mais informações, consulte
Como criar um novo ambiente na interface.
Se você não tiver anexado o ambiente a uma instância durante a criação dele ou quiser remover um
ambiente de uma instância, siga as etapas a seguir. Para mais informações sobre ambientes e instâncias, consulte Ambientes e instâncias.
Para anexar ou remover um ambiente de uma instância usando a Apigee no console do Cloud:
Na página Detalhes da instância, clique em Editar.
Na página Editar instância, clique no campo Ambientes (opcional) e
selecione o ambiente que você quer
anexar à instância ou desmarque o ambiente que você quer remover.
Clique em OK.
Clique em Salvar.
Além de usar a interface, também é possível anexar ambientes a uma instância usando a
API Instances attachment create. Por exemplo, consulte
Criar
um ambiente na documentação de provisionamento de linha de comando.
Editar a lista de projetos aceitos
É possível adicionar ou remover projetos da lista de Projetos aceitos:
Na página Detalhes da instância, clique em Editar.
Na seção Projetos aceitos da página Editar instância, clique no ícone de exclusão ao lado de um projeto para removê-lo.
Para adicionar um projeto, clique em Adicionar projeto aceito e digite o ID do projeto.
Clique em Salvar.
Ativar ou desativar registros de acesso de entrada para uma instância
Depois de criar uma instância, você pode ativar e desativar os registros de acesso de entrada do Cloud Logging para a instância:
Apenas uma instância da Apigee pode estar em uma determinada região do Google Cloud. Quando você exclui uma instância, ela é completamente removida da região. Consulte também
Instalação multirregional.
Aviso: quando você exclui uma instância, todos os dados associados
a ela são perdidos. Ela não pode ser desfeita. No entanto, se você tiver
várias instâncias, como em uma instalação multirregional, seus dados serão perdidos somente
se você excluir todas as instâncias. Antes de excluir a última instância, extraia
e faça backup dos dados que você não quer perder.
Os dados a seguir serão armazenados em uma instância da Apigee e serão excluídos se você excluir
a instância:
Tipo de dados
Descrição
Sistema de gerenciamento de chaves (KMS)
Os dados do KMS incluem produtos, desenvolvedores, apps de desenvolvedor, tokens OAuth (incluindo tokens de acesso, tokens de atualização e códigos de autorização) e chaves de API.
Use a política AccessEntity ou a API Apigee relacionada para
recuperar os dados que você quer salvar.
Mapa de chave-valor (KVM)
Todos os dados que podem ser criados ou gerenciados com políticas da KVM. Consulte
Como recuperar KVMs.
Cota
Definições de cotas, buckets e contadores.
Cache do ambiente
Todos os dados em cache.
Para excluir uma instância da Apigee usando a interface da Apigee no console do Cloud:
[[["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 page outlines how to manage Apigee instances, which are virtual machines storing your API project and services, and it's important to note that this content does not apply to Apigee hybrid.\u003c/p\u003e\n"],["\u003cp\u003eYou can create a new instance via the Apigee UI or Instances API, each requiring a unique disk encryption key and non-overlapping CIDR ranges for network peering.\u003c/p\u003e\n"],["\u003cp\u003eInstances can have environments attached or removed, and these associations can be managed through the Apigee UI or the Instances attachment create API.\u003c/p\u003e\n"],["\u003cp\u003eThe list of Cloud projects that can connect to an instance can be managed by adding or removing projects in the "Accepted projects" list, and this can be done through the UI.\u003c/p\u003e\n"],["\u003cp\u003eDeleting an instance will remove all associated data, including KMS, KVM, quota data, and environment cache, and it will also remove the association for any attached environments.\u003c/p\u003e\n"]]],[],null,["# Managing instances\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\nAn [instance](/apigee/docs/api-platform/get-started/create-instance) is a virtual\nmachine where your API project and related services are stored. Instances correspond to regions.\nTypically, you start with a single instance and add new instances as your organization expands\ninto more regions. This section explains how to:\n\n- [Create a new instance](#create-a-new-instance).\n- [Attach or remove environments from an instance](#add-envs).\n- [Edit the accepted projects list](#accepted-projects)\n- [Enable or disable ingress access logs for an instance](#enable-logging).\n- [Delete an instance](#delete-an-instance).\n\n| **Note:** Evaluation organizations can only have one instance (region).\n| To expand beyond a single region and instance, you must have a\n| [paid organization](/apigee/docs/api-platform/fundamentals/organization-structure#org_types). Your subscription entitlements limit the number of instances (regions) you can add.\n| You can add more instances (regions) by purchasing an Org Pack. For more information,\n| see [Subscription entitlements](/apigee/docs/api-platform/reference/subscription-entitlements).\n\nCreate a new instance\n---------------------\n\nTo create a new instance, you can use the [Instances API](/apigee/docs/reference/apis/apigee/rest/v1/organizations.instances) or the Apigee UI. Each instance requires:\n\n- its own disk encryption key for the network. Apigee recommends that you also create a separate key ring for the new instance. For more information, see [About the Apigee encryption keys](/apigee/docs/api-platform/security/encryption-keys).\n- its own non-overlapping /22 and /28 CIDR ranges for network peering. The ranges cannot be shared between instances.\n\n**Note:** You must have a paid organization to add an instance. Evaluation accounts are limited to one region or instance and cannot be expanded to a second. Your entitlements limit the number of regions you can add. For more information, see [Apigee Pricing](https://cloud.google.com/apigee/pricing). \n\n### Apigee in Cloud console\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\nTo create a new instance in Apigee in Cloud console:\n\n1. In the Google Cloud console, go to the **Management \\\u003e Instances** page.\n\n [Go to Instances](https://console.cloud.google.com/apigee/instances)\n The **Instances** pane displays a list of existing instances.\n\n \u003cbr /\u003e\n\n2. Click **+ Create**. There might be a delay while the UI determines if\n your org has the proper entitlements to create a new instance.\n\n The **Create new instance** page displays.\n3. Enter details about your new instance in the fields:\n\n If your org cannot create a new instance, contact [Apigee Sales](https://pages.apigee.com/contact-sales-reg.html).\n4. Click **Create**.\n\n Apigee begins a long-running operation that can take 20 minutes\n or more to complete. When it's done, the new instance will appear in the list of instances in\n the **Instances** UI.\n\n### Apigee API\n\nIf Apigee was provisioned without VPC-peering, see [Create a runtime instance](/apigee/docs/api-platform/get-started/install-cli-non-peered#runtime-instance) in the non-VPC peering provisioning steps.\n\nIf Apigee was provisioned with VPC-peering, see [Create a runtime instance](/apigee/docs/api-platform/get-started/install-cli#runtime-instance) in the VPC peering provisioning steps.\n\nAttach or remove environments from an instance\n----------------------------------------------\n\nWhen you create an environment using the Apigee UI in Google Cloud console, you have the option to assign the\nenvironment to an existing instance. For more information, see [Creating a new environment in the UI](/apigee/docs/api-platform/fundamentals/environments-working-with#creating-a-new-environment-in-the-ui).\n\nIf you did not attach your environment to an instance during environment creation, or you want to remove an\nenvironment from an instance, you can follow these steps. For more information on environments and instances, see [Environments and instances](/apigee/docs/api-platform/fundamentals/environments-working-with#environments-and-instances).\n\nTo attach or remove an environment from an instance using Apigee in Cloud console:\n\n1. In the Google Cloud console, go to the **Management \\\u003e Instances** page.\n\n [Go to Instances](https://console.cloud.google.com/apigee/instances)\n2. Click the instance that you want to edit.\n\n3. In the **Instance details** page, click **Edit**.\n4. In the **Edit Instance** page, click the **Environments (optional)** field and select the environment you want to attach to the instance, or deselect the environment you want to remove.\n5. Click **OK**.\n6. Click **Save** to save your changes.\n\nIn addition to using the UI, you can also attach environments to an instance using the\n[Instances attachment create API](/apigee/docs/reference/apis/apigee/rest/v1/organizations.instances.attachments/create). For an example, see\n[Create\nan environment](/apigee/docs/api-platform/get-started/install-cli#create-environment) in the command-line provisioning documentation.\n\nEdit the accepted projects list\n-------------------------------\n\nYou can add or remove projects from the **Accepted projects** list:\n\n1. In the Google Cloud console, go to the **Management \\\u003e Instances** page.\n\n [Go to Instances](https://console.cloud.google.com/apigee/instances)\n2. Click the instance that you want to edit.\n\n3. In the **Instance details** page, click **Edit**.\n4. In the **Accepted projects** section of the **Edit Instance** page, click delete **Delete** next to a project to remove it. To add a project click **Add accepted project** and enter the ID of the project to add.\n5. Click **Save** to save your changes.\n\nEnable or disable ingress access logs for an instance\n-----------------------------------------------------\n\nAfter you create an instance, you can enable and disable Cloud Logging ingress access logs for the instance:\n\n1. In the Google Cloud console, go to the **Management \\\u003e Instances** page.\n\n [Go to Instances](https://console.cloud.google.com/apigee/instances)\n2. Click the instance that you want to edit.\n\n3. In the **Instance details** page, click **Edit**.\n4. the **Edit Instance** page, click the **Enable logging** toggle to disable the feature.\n5. Click **Save** to save your changes.\n\nDelete an instance\n------------------\n\nYou can use the Apigee UI to delete an existing instance, as described in this section.\nAlternatively, you can delete an instance using the [Instances API](/apigee/docs/reference/apis/apigee/rest/v1/organizations.instances).\n\nOnly one Apigee instance can be in a given Google Cloud region. When you delete an instance,\nit is completely removed from its region. See also\n[multi-region installation](/apigee/docs/api-platform/system-administration/multi-region).\n**Warning:** When you delete an instance, all data associated with that instance is lost. This step cannot be undone. Note, however, that if you have multiple instances, such as in a multi-region installation, your data will be lost only if you delete all of the instances. Before deleting the last instance, be sure to extract and back up any data you do not wish to lose. **Note:** Deleting an instance removes the association for any attached environments. You may need to move any attached environments to new instances by [Attaching and removing environments from an instance](#add-envs) before deleting the instance. All environments must be attached to at least one instance for their proxies to function.\n\nThe following data is stored in an Apigee instance and will be deleted if you delete\nthe instance:\n\nTo delete an Apigee instance using the Apigee UI in Cloud console:\n\n1. In the Google Cloud console, go to the **Management \\\u003e Instances** page.\n\n [Go to Instances](https://console.cloud.google.com/apigee/instances)\n2. Click the instance that you want to delete.\n3. In the **Instance Details** page, click **Delete**."]]
