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

编排规则管理

API网关支持对API进行参数编排,根据请求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。

创建编排规则

  1. 进入API网关控制台页面。
  2. 根据实际业务在左侧导航栏上方选择实例。
  1. 在左侧导航栏选择“API管理 > API策略”。
  2. 单击“编排规则管理”页签。
  3. 单击“创建编排规则”,配置编排规则。

    表1 编排规则配置

    参数

    说明

    规则名称

    填写编排规则的名称,根据规划自定义。

    编排策略

    选择编排策略。

    • list:列表中的值映射成另外的值。
    • range:范围中的值映射成另外的值。
    • hash:请求头的值经过哈希计算后直接映射为新的请求头。
    • hash_range:先用请求参数生成hash值,再用hash值进行range编排。
    • none_value:请求参数为空时将返回none_value策略的编排映射值。
    • default:请求参数存在,但是没有编排规则可以匹配上请求参数时,将返回default策略的编排映射值。
    • head_n:用于截取字符串前n项(如果n大于字符串长度,会返回完整的原始参数值),生成一个临时参数,后面的编排规则用这个临时参数值进行编排。
    • tail_n:用于截取字符串后n项(如果n大于字符串长度,会返回完整的原始参数值),生成一个临时参数,后面的编排规则用这个临时参数值进行编排。

    是否预处理策略

    当“编排策略”选择“list”、“range”、“hash”、“hash_range”、“head_n”、“tail_n”时可见。

    配置是否预处理策略。当编排规则为预处理时,将该编排规则生成的参数值作为临时参数,成为下一个编排规则的待编排参数。

    参数名称

    当“是否预处理策略”开关关闭或者“编排策略”选择“none_value”或“default”时需要配置。

    填写编排后的参数名称。

    参数类型

    当“是否预处理策略”开关关闭或者“编排策略”选择“none_value”或“default”时需要配置。

    选择参数类型。

    • string
    • number

    参数位置

    当“是否预处理策略”开关关闭或者“编排策略”选择“none_value”或“default”时需要配置。

    选择参数位置。

    • header
    • query

    映射信息

    当“编排策略”选择“list”、“range”、“hash_range”、“none_value”、“default”时需要配置。

    填写参数映射信息。单击“新增映射信息”,可添加新的映射信息。

    • 编排前的请求参数值
      • 当“编排策略”选择“list”,输入编排前的请求参数值。
      • 当“编排策略”选择“range”或“hash_range”,输入区间起始值和终止值。
    • 编排后的请求参数值:输入编排后的请求参数值。

    截取长度

    当“编排策略”选择“head_n”或“tail_n”时需要配置。

    配置截取字符串的长度。

  4. 单击“确定”。

相关文档