在 XML 文件中关联和配置政策

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

您可以使用自己喜欢的文本或者 XML 感知编辑器或 IDE 在本地创建和修改政策。本主题使用配额政策类型作为如何创建、配置、附加、部署和测试政策的示例。

大多数 API 代理都会强制执行配额。配额可用于控制客户端应用可在给定的时间间隔内调用 API 的频率。在以下示例中，将配额政策配置为将应用限制为每分钟 1 个请求。（虽然这可能不现实，但可以提供查看政策效果的简单方法。）

在 API 代理配置中，政策文件以 XML 文件的形式存储在 /apiproxy/policies 目录下。

例如，可以将名为 Quota Policy 类型的配额政策创建为名为 QuotaPolicy.xml 的文件，其中包含以下内容：

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

您可以手动创建文本文件，也可以根据 XML 架构生成政策。所有政策都具有一些特定于政策类型的设置，以及一些在所有政策中通用的设置。

在管理界面中附加政策时，API 代理构建器会从所选政策类型的 XML 架构生成政策实例。因此，为明确起见，可能会在政策配置中看到不一定包含在文档中的元素。

所有政策都定义以下属性：

  • enabled：表示政策是处于启用还是停用状态。您可以更改此设置以在运行时启用/停用政策。系统不会强制执行将 enabled 设置为 false 的政策。
  • continueOnError：定义在政策失败时流水线是否应继续处理消息。强制执行配额政策时，错误可能表示已超出配额，因此，应将此属性设置为 false。
  • name：您为此政策指定的名称。此名称对于此政策实例是唯一的，并用于将政策作为处理步骤附加到流。

在上面的示例中，Allow、Interval 和 TimeUnit 元素特定于配额政策。这些元素提供 API 服务代表 API 强制执行的设置。其他政策类型定义自己的设置，您可以在政策参考中了解这些设置。