你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
API 管理策略参考
本部分提供所有 API 管理策略的参考文章链接。
有关策略的详细信息:
重要
按订阅限制调用率和按订阅设置使用量配额依赖于订阅密钥。 应用其他策略时不需要订阅密钥。
访问限制策略
- 检查 HTTP 标头 - 强制 HTTP 标头必须存在和/或强制采用 HTTP 标头的值。
- 获取授权上下文 - 获取 API 管理实例中配置的指定授权的授权上下文。
- 按订阅限制调用速率 - 根据订阅限制调用速率,避免 API 使用量暴增。
- 按密钥限制调用速率 - 根据密钥限制调用速率,避免 API 使用量暴增。
- 限制调用方 IP - 筛选(允许/拒绝)来自特定 IP 地址和/或地址范围的调用。
- 按订阅设置使用量配额 - 允许根据订阅强制实施可续订或有生存期的调用量和/或带宽配额。
- 按密钥设置使用量配额 - 允许根据密钥强制消耗可续订或有生存期的调用量和/或带宽配额。
- 验证 Azure Active Directory 令牌 - 强制要求从指定 HTTP 标头、查询参数或令牌值中提取的 Azure Active Directory JWT 存在且有效。
- 验证 JWT - 强制要求从指定 HTTP 标头、查询参数或令牌值提取的 JWT 存在且有效。
- 验证客户端证书 - 强制客户端提供给 API 管理实例的证书与指定的验证规则和声明相匹配。
高级策略
- 控制流 - 根据布尔表达式的求值结果,有条件地应用策略语句。
- 发出指标 - 在执行时将自定义指标发送到 Application Insights。
- 转发请求 - 将请求转发到后端服务。
- 包括片段 - 在策略定义中插入策略片段。
- 限制并发 - 阻止括住的策略一次执行超过指定数量的请求。
- 记录到事件中心 - 将指定格式的消息发送到记录器实体定义的事件中心。
- 模拟响应 - 中止管道执行,将模拟的响应直接返回给调用方。
- 重试 - 重试执行括住的策略语句,直到符合条件为止。 系统会按指定的时间间隔重复执行,直到达到指定的重试计数为止。
- 返回响应 - 中止管道执行,将指定的响应直接返回给调用方。
- 发送单向请求 - 将请求发送到指定的 URL,无需等待响应。
- 发送请求 - 将请求发送到指定的 URL。
- 设置 HTTP 代理 - 允许通过 HTTP 代理路由转发请求。
- 设置请求方法 - 允许更改请求的 HTTP 方法。
- 设置状态代码 - 将 HTTP 状态代码更改为指定的值。
- 设置变量 - 保存命名上下文变量中的值供以后访问。
- 跟踪 - 将自定义跟踪添加到测试控制台、Application Insights 遥测和资源日志中的请求跟踪输出中。
- 等待 - 在继续下一步之前,等待括住的发送请求、从缓存中获取值或控制流策略完成。
身份验证策略
- 使用基本方法进行身份验证 - 使用基本身份验证方法向后端服务进行身份验证。
- 使用客户端证书进行身份验证 - 使用客户端证书向后端服务进行身份验证。
- 使用托管标识进行身份验证 - 使用托管标识向后端服务进行身份验证。
缓存策略
- 从缓存中获取 - 执行缓存查找,并返回有效的缓存响应(如果有)。
- 存储到缓存 - 根据指定的缓存控制配置来缓存响应。
- 从缓存中获取值 - 按密钥检索缓存项。
- 在缓存中存储值 - 按密钥在缓存中存储项。
- 从缓存中删除值 - 按密钥在缓存中删除项。
跨域策略
- 允许跨域调用 - 使 API 能够通过 Adobe Flash 和基于 Microsoft Silverlight 浏览器的客户端进行访问。
- CORS - 向操作或 API 添加跨源资源共享 (CORS) 支持,允许从基于浏览器的客户端进行跨域调用。
- JSONP - 向操作或 API 添加填充型 JSON (JSONP) 支持,以便从基于 JavaScript 浏览器的客户端执行跨域调用。
Dapr 集成策略
- 发送对服务的请求:使用 Dapr 运行时查找 Dapr 微服务并与之进行可靠的通信。 若要了解有关 Dapr 中服务调用的详细信息,请参阅这个 README 文件中的说明。
- 将消息发送到发布/订阅主题:使用 Dapr 运行时将消息发布到发布/订阅主题。 若要了解有关 Dapr 中发布/订阅消息的详细信息,请参阅这个 README 文件中的说明。
- 触发器输出绑定:使用 Dapr 运行时通过输出绑定调用外部系统。 若要了解有关 Dapr 中绑定的详细信息,请参阅此 README 文件中的说明。
GraphQL 解析程序策略
- 解析程序的 HTTP 数据源 - 配置 HTTP 请求和 HTTP 响应(可选),以解析 GraphQL 架构中对象类型和字段的数据。
- 将事件发布到 GraphQL 订阅 - 将事件发布到 GraphQL API 架构中指定的一个或多个订阅。 在
http-data-source
策略的http-response
元素中使用
转换策略
- 将 JSON 转换为 XML - 将请求或响应正文从 JSON 转换为 XML。
- 将 XML 转换为 JSON - 将请求或响应正文从 XML 转换为 JSON。
- 查找并替换正文中的字符串 - 查找请求或响应子字符串,并将其替换为不同的子字符串。
- 在内容中屏蔽 URL - 重写(屏蔽)响应正文中的链接,使其通过网关指向等效的链接。
- 设置后端服务 - 更改传入请求的后端服务。
- 设置正文 - 设置传入和传出请求的消息正文。
- 设置 HTTP 标头 - 向现有的响应和/或请求标头赋值,或者添加新的响应和/或请求标头。
- 设置查询字符串参数 - 添加、删除请求查询字符串参数或替换其值。
- 重写 URL - 将请求 URL 从其公用格式转换为 Web 服务所需的格式。
- 使用 XSLT 转换 XML - 在请求或响应正文中将 XSL 转换应用到 XML。
验证策略
- 验证内容 - 根据一个或多个 API 架构验证请求或响应正文的大小或内容。 支持的架构格式为 JSON 和 XML。
- 验证 GraphQL 请求 - 验证对 GraphQL API 的请求并授权。
- 验证参数 - 根据 API 架构验证请求头、查询或路径参数。
- 验证标头 - 根据 API 架构验证响应标头。
- 验证状态代码 - 根据 API 架构验证响应中的 HTTP 状态代码。
后续步骤
有关使用策略的详细信息,请参阅: