更新时间:2024-08-07 GMT+08:00

创建策略并绑定API

通过策略的方式,为API提供灵活的控制策略和扩展能力。

策略参数会明文展示,为防止信息泄露,请谨慎配置。

前提条件

  • 一个API只能绑定一个相同类型的策略。
  • 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。
  • 策略的绑定、解绑、更新会实时生效,不需要重新发布API。
  • API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。
  • 如果策略与API有绑定关系,则策略无法执行删除操作。

创建策略

  1. 进入API网关控制台页面。
  2. 根据实际业务在左侧导航栏上方选择实例。
  1. 在左侧导航栏选择“API管理 > API策略”。
  2. 在“策略管理”页面,单击“创建策略”。
  3. 单击需要创建的策略类型。

    • 插件策略
      在创建策略弹窗中配置策略信息。
      表1 策略配置

      参数

      说明

      策略名称

      填写策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。

      策略类型

      选择策略的类型,不同类型的策略提供不同扩展能力。

      说明:

      如果您要使用以下的某个策略在当前实例中不支持,请联系技术支持升级实例到最新版本。

      • 跨域资源共享策略:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。
      • HTTP响应头管理策略:可以自定义HTTP响应头,在返回的API响应中指定配置的响应头。
      • 流量控制2.0策略:可以限制单位时间内API的被调用次数,支持参数流控、基础流控和基于基础流控的特殊流控。
      • Kafka日志推送策略:Kafka日志推送策略提供了把API的详细调用日志推送到Kafka的能力,方便用户获取API的调用日志信息。
      • 断路器策略:断路器是API网关在后端服务出现性能问题时保护系统的内置机制。
      • 第三方认证策略:通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。

      描述

      填写策略的描述信息。

      策略内容

      策略的配置内容,支持表单配置和脚本配置两种方式。

      不同的策略类型,策略内容的配置不同:

    • 传统策略

      不同的策略类型,策略内容的配置不同:

  4. 单击“确定”。

    • 如果您需要复制已创建的策略,请在已创建策略的“操作”列中单击“克隆”配置参数即可。
      • 克隆策略的名称不能与已创建的策略名称重复。
      • 流量控制策略签名密钥策略不支持克隆。
    • 策略创建后,您还需要为策略绑定API,才能使策略对API生效。

为策略绑定API

  1. 单击策略名称,进入策略详情。
  2. 在“关联API”区域选择环境后,单击“绑定API”。
  3. 筛选API分组以及发布环境,勾选所需的API。
  4. 单击“确定”,绑定完成。

    • 如果单个API不需要绑定此策略,单击API所在行的“解绑”。
    • 如果批量API不需要绑定此策略,则勾选待解绑的API,单击列表上方“解绑”。最多同时解绑1000个API。