管理实例

本页面适用于 Apigee,但不适用于 Apigee Hybrid

查看 Apigee Edge 文档。

实例是存储 API 项目和相关服务的虚拟机。实例对应于区域。通常,您可以从单个实例开始,并在组织扩展到更多区域时添加新实例。本节介绍如何执行以下操作:

创建新实例

要创建新实例,您可以使用 Instances API 或 Apigee 界面。每个实例都需要:

  • 用于网络的磁盘加密密钥。Apigee 建议您也为新实例创建单独的密钥环。如需了解详情,请参阅 Apigee 加密密钥简介
  • 用于网络对等互连的不重叠 /22 和 /28 CIDR 范围。这些范围无法在实例之间共享。

Cloud 控制台中的 Apigee

如需在 Cloud 控制台的 Apigee 中创建新实例,请执行以下操作:

  1. 在浏览器中打开 Cloud 控制台中的 Apigee 界面
  2. 依次选择管理 > 实例实例窗格会显示现有实例的列表。

  3. 点击 + 创建 (+ Create)。可能会出现一点延迟,因为界面需要确定您的组织拥有创建新实例的适当权益。

    此时将显示创建新实例页面。

  4. 在以下字段中输入新实例的详细信息:
    字段 必填 说明
    Runtime hosting location 必填 选择要在其中创建新实例的区域。您不能在已拥有实例的区域中创建新实例。如需详细了解如何使用多个区域,请参阅使用多个区域
    Name 必填

    输入新实例的 ID。

    默认值是您选择的运行时托管区域的名称,您可以将其更改为您需要的任何有意义的名称,只要符合以下命名规则即可:

    • 长度下限为 2 个字符。
    • 长度上限为 32 个字符。
    • 只能使用小写字母、数字和连字符(遵循 /^[a-z0-9\-]+$/ 模式)。
    • 必须以字母开头;不含前导数字或连字符。
    • 必须以数字或字母结尾;末尾没有连字符。
    • 在组织中必须是唯一的。
    IP range allocation 必填

    指定您希望如何分配 IP 范围。从以下选项中进行选择:

    • 自动(推荐)- Apigee 会选择前缀大小为 /22 的可用 CIDR 范围。您无需采取任何进一步行动。
    • 自定义 - 在高级用例中,您可能需要准确指定 Apigee 要使用的 IP 地址范围。对于这些情况,您需要指定自定义 IP 范围,并且其前缀大小为 /22。该范围必须可作为您的项目与 Apigee 之间的专用连接的一部分使用。
    Disk encryption key 必填

    磁盘加密密钥下,选择客户管理的加密密钥。如果存在现有密钥,您也可以选择现有密钥。该向导会在所有密钥环中列出与运行时托管区域位于同一位置的所有密钥。如果不存在任何密钥,或者您不想使用现有密钥,则可以通过该向导创建新密钥。如要创建项,请执行以下操作:

    1. 点击创建密钥
    2. 选择密钥环;如果密钥环不存在,请启用创建密钥环,然后输入密钥环名称并选择密钥环位置。密钥环名称可以包含字母、数字、下划线 (_) 和连字符 (-)。不能重命名或删除密钥环。
    3. 点击继续
    4. 创建密钥。输入名称和保护级别。 请注意,密钥名称可以包含字母、数字、下划线 (_) 和连字符 (-)。不能重命名或删除密钥。对于保护级别而言,软件是一个好的选择。这是 Cloud KMS 使用的同一默认值;不过,您可以根据需要进行更改。
    5. 点击继续,然后检查您的选择。
    6. 点击创建
    7. 点击授权,向服务账号授予使用所选密钥进行加密/解密的权限。
    Environments 可选

    选择要关联到此实例的环境。为此,请点击环境下拉列表,然后选中您要关联的环境旁边的复选框。您可以根据需要选中任意数量的环境。 然后点击确定

    请注意,所有实例的环境都会计入您可以分配的环境总数。如需了解详情,请参阅环境和环境组简介

    在创建新实例时添加环境是可选操作。如果您现在不再添加环境,可以在稍后使用实例关联创建 API 或界面来添加和移除环境。请参阅关联或移除环境

    Accepted projects 可选 点击添加接受的项目,选择一个或多个 Cloud 项目。所选项目可以非公开方式连接到您实例的服务连接。默认情况下,与 Apigee 组织关联的项目包含在此列表中。
    Enable logging 可选 点击启用日志记录切换开关,为实例启用 Cloud Logging 入口访问日志。借助此功能,您可以查看 Apigee 基础设施中的入站流量网关(例如外部应用负载均衡器或 Anthos 网关)生成的日志,以协助排查 Apigee API 调用问题。

    如需了解详情,请参阅记录 Apigee 访问日志

    Filter 可选 响应代码框中选择一个 HTTP 响应代码,充当入站流量访问日志的过滤条件。

    如果您要包含所有日志,而不考虑 HTTP 响应代码,请选择 None (all HTTP responses)

    如需创建自定义过滤条件,请选择 Custom,然后按以下格式输入过滤条件:

    status_code > XX && status code <= YY

    例如:

    status_code >= 500 && status_code < 504

    如果您的组织无法创建新实例,请与 Apigee 销售人员联系。

  5. 点击创建

    Apigee 会启动一个长时间运行的操作,可能需要 20 分钟或更长时间才能完成。完成后,新实例会显示在实例界面的实例列表中。

Apigee API

如果 Apigee 是在不使用 VPC 对等互连的情况下预配的,请参阅非 VPC 对等互连预配步骤中的创建运行时实例

如果 Apigee 是在使用 VPC 对等互连的情况下预配的,请参阅 VPC 对等互连预配步骤中的创建运行时实例

在实例中添加或移除环境

使用 Google Cloud 控制台中的 Apigee 界面创建环境时,您可以选择将环境分配给现有实例。如需了解详情,请参阅在界面中创建新环境

如果您在创建环境期间未将环境关联到实例,或者要从实例中移除环境,则可以按照以下步骤操作。如需详细了解环境和实例,请参阅环境和实例

如需使用 Cloud 控制台中的 Apigee 在实例中附加环境或从中移除环境,请执行以下操作:

  1. 在浏览器中打开 Cloud 控制台中的 Apigee 界面
  2. 依次选择管理 > 实例
  3. 点击您要修改的实例。

  4. 实例详情页面中,点击修改
  5. 修改实例页面中,点击环境(可选)字段,然后选择要将环境关联到实例,或取消选择要移除的环境。
  6. 点击确定
  7. 点击保存以保存更改。

除了使用界面之外,您还可以使用实例关联创建 API 来将环境关联到实例。如需查看示例,请参阅命令行预配文档中的创建环境

修改“接受的项目”列表

您可以在接受的项目列表中添加或移除项目:

  1. 在浏览器中打开 Cloud 控制台中的 Apigee 界面
  2. 依次选择管理 > 实例
  3. 点击您要修改的实例。

  4. 实例详情页面中,点击修改
  5. 修改实例页面的接受的项目部分中,点击项目旁边的删除图标以将其移除。如要添加项目,请点击添加接受的项目,然后输入要添加的项目的 ID。
  6. 点击保存以保存更改。

为实例启用或停用入口访问日志

创建实例后,您可以为该实例启用和停用 Cloud Logging 入站流量访问日志:

  1. 在浏览器中打开 Cloud 控制台中的 Apigee 界面
  2. 依次选择管理 > 实例
  3. 点击您要修改的实例。

  4. 实例详情页面中,点击修改
  5. 修改实例页面,点击启用日志记录切换开关以停用该功能。
  6. 点击保存以保存更改。

删除实例

您可以使用 Cloud 控制台中的 Apigee 界面删除现有实例,如本部分所述。或者,您也可以使用 Instances API 删除实例。

一个给定的 Google Cloud 区域中只能有一个 Apigee 实例。删除实例时,实例会从其区域中完全移除。另请参阅多区域安装

警告:删除实例时,与该实例关联的所有数据都将丢失。此步骤无法撤消。但请注意,如果您有多个实例(例如在多区域安装中),则只有在您删除所有实例时,您的数据才会丢失。在删除最后一个实例之前,请务必提取并备份您不想丢失的所有数据。

以下数据存储在 Apigee 实例中,如果您删除该实例,则会将其删除:

数据类型 说明
密钥管理系统 (KMS) KMS 数据包括 API 产品、开发者、开发者应用、OAuth 令牌(包括访问令牌、刷新令牌和授权代码)和 API 密钥。 使用 AccessEntity 政策或相关的 Apigee API 检索您要保存的数据。
键值对映射 (KVM) 可以使用 KVM 政策创建或管理的任何数据。 请参阅检索 KVM
配额 配额定义、存储桶和计数器。
环境缓存 所有缓存的数据。

如需使用 Cloud 控制台中的 Apigee 界面删除 Apigee 实例,请执行以下操作:

  1. 在浏览器中打开 Cloud 控制台中的 Apigee 界面
  2. 依次选择管理 > 实例

  3. 点击要删除的实例。
  4. 实例详情页面上,点击删除