创建API策略
支持通过策略的方式,为API提供灵活的扩展能力。
前提条件
- 一个API只能绑定一个相同类型的策略。
- 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。
- 策略的绑定、解绑、更新会实时生效,不需要重新发布API。
- API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。
- 如果策略与API有绑定关系,则策略无法执行删除操作。
创建策略
- 登录ROMA API控制台。
- 在控制台单击
,选择区域,在“ROMA API”下选择待操作的应用。
- 在左侧导航栏选择“API管理 > API策略”。
- 在当前应用关联的实例中,根据实际业务选择实例。
- 单击“创建策略”,选择策略类型。
- 插件策略:通过插件的形式,提供灵活的扩展能力。目前支持跨域资源共享和HTTP响应头管理。
- 传统策略:流量控制、访问控制和签名密钥。
- 单击“创建策略”,配置策略信息。
- 插件策略请参考下表配置:
表1 插件策略配置 参数
配置说明
策略名称
填写策略的名称,根据规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。
策略类型
选择策略的类型,不同类型的策略提供不同扩展能力。
- 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。
- HTTP响应头管理策略:可以自定义HTTP响应头,在返回的API响应中指定配置的响应头。
可见范围
当实例为ROMA类型时,支持设置当前应用可见或全局应用可见。
描述
填写策略的描述信息。
策略内容
策略的配置内容,支持表单配置和脚本配置两种方式。
根据不同的策略类型,策略内容的配置不同:
- 传统策略请参考:
- 插件策略请参考下表配置:
- 单击“确定”,创建策略。
策略创建后,您还需要为API绑定策略,才能使策略对API生效。