/

Console

• English
• Deutsch
• Español
• Español – América Latina
• Français
• Indonesia
• Italiano
• Português
• Português – Brasil
• עברית
• 中文 – 简体
• 中文 – 繁體
• 日本語
• 한국어

Sign in

• Apigee

Start free

Managing instances

View Apigee Edge documentation.

An instance is a virtual machine where your API project and related services are stored. Instances correspond to regions. Both Apigee (managed) and Apigee hybrid instances are displayed in the Apigee UI. Typically, you start with a single instance and add new instances as your organization expands into more regions. This section explains how to:

• View your instances.
• Create a new Apigee (managed) instance.
• Attach or remove environments from an instance.
• Edit the accepted projects list
• Enable or disable ingress access logs for an instance.
• Delete an instance.

View your instances

You can view all your instances, both managed and hybrid, in the Apigee UI:

1. In the Google Cloud console, go to the Apigee > Management > Instances page.

   Go to Instances

2. The Instances pane displays a list of existing instances.

   For Apigee hybrid instances, the list displays the instance name, location, and runtime version. Apigee hybrid instances are read-only in the UI; you must use command-line tools to create or manage them.

Create a new managed instance

To create a new managed instance, you can use the Instances API or the Apigee UI. Each instance requires:

• 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.
• its own non-overlapping /22 and /28 CIDR ranges for network peering. The ranges cannot be shared between instances.

Apigee UI

To create a new instance in Apigee UI:

Enter the ID of the new instance.

The default value is the name of the runtime hosting region that you selected, but you can change it to any meaningful name that you want, as long as you follow the naming rules:

• Minimum length of 2.
• Maximum length of 32.
• Only use lower case letters, numbers, and hyphens (following the pattern /^[a-z0-9\-]+$/).
• Must start with a letter; doesn't have leading digits or hyphens.
• Must end with a number or letter; doesn't have trailing hyphens.
• Must be unique across your org.

Specify how you want to allocate an IP range. Choose between these options:

• Automatic (Recommended) - Apigee selects an available CIDR range with a prefix size of /22. No further action on your part is required.
• Custom - In advanced use cases, you may need to specify exactly which IP range you want Apigee to use. For these cases, you specify a custom IP range, and it must have a prefix size of /22. The range must be available as part of a private connection between your project and Apigee.

Under Disk encryption key, choose a customer-managed encryption key. If a key already exists, you can pick it. The wizard lists all keys in the same location as the runtime hosting region across all key rings. If a key doesn't exist, or if you don't want to use an existing key, you can create a new key from within the wizard. To create a key:

1. Click Create key.
2. Select a key ring, or if one doesn't exist, enable Create key ring and enter a key ring name and pick a key ring location. Key ring names can contain letters, numbers, underscores (_), and hyphens (-). Key rings can't be renamed or deleted.
3. Click Continue.
4. Create a key. Enter a name and protection level. Note that key names can contain letters, numbers, underscores (_), and hyphens (-). Keys can't be renamed or deleted. For protection level, Software is a good choice. This is the same default used by Cloud KMS; however, you can change it if you wish.
5. Click Continue and review your selections.
6. Click Create.
7. Click Grant to grant the service account permission to encrypt/decrypt with the selected key.

Select the environments you want attached to this instance. To do this, click the Environments drop-down list and select the checkboxes next to the environments you want to attach. You can do this for as many environments as you want. Then click OK.

Note that all instances' environments count towards the total number of environments that you can have allocated. For more information, see About environments and environment groups.

Adding environments when you create a new instance is optional. If you do not add them now, you can instead use the Instances attachment create API or the UI to add and remove them later. See Attach or remove an environment.

For more information, see Logging Apigee access logs

If you want to include all logs, regardless of HTTP response code, select None (all HTTP responses).

To create a custom filter, select Custom and enter the filter in the following format:

status_code > XX && status code <= YY

For example:

status_code >= 500 && status_code < 504

If your org cannot create a new instance, contact Apigee Sales.

Attach or remove environments from a managed instance

When you create an environment using the Apigee UI in Google Cloud console, you have the option to assign the environment to an existing instance. For more information, see Creating a new environment in the UI.

If you did not attach your environment to an instance during environment creation, or you want to remove an environment from an instance, you can follow these steps. For more information on environments and instances, see Environments and instances.

To attach or remove an environment from an instance using the Apigee UI:

Click the instance that you want to edit.

In addition to using the UI, you can also attach environments to an instance using the Instances attachment create API. For an example, see Create an environment in the command-line provisioning documentation.

Edit the accepted projects list (managed only)

Click the instance that you want to edit.

Enable or disable ingress access logs for an instance

Click the instance that you want to edit.

Delete a managed instance

You can use the Apigee UI to delete an existing instance, as described in this section. Alternatively, you can delete an instance using the Instances API.

Only one Apigee instance can be in a given Google Cloud region. When you delete an instance, it is completely removed from its region. See also multi-region installation.

The following data is stored in an Apigee instance and will be deleted if you delete the instance:

To delete an Apigee instance using the Apigee UI:

1. In the Google Cloud console, go to the Management > Instances page.

   Go to Instances

2. Click the instance that you want to delete.
3. In the Instance Details page, click Delete.