execute

组合件的 execute 字段具有以下结构:

execute:
 - Policy_1
 - Policy_2
注: 虽然部分内置策略可用于 DataPower® Gateway(与 v5 兼容)DataPower API Gateway,但有些策略仅限适用于特定网关。以下图标指示可配合每项策略使用的网关:
  • DataPower Gateway 图标 指示此策略可在 DataPower Gateway(与 v5 兼容) 上运行。
  • DataPower Gateway 图标 指示此策略可在 DataPower API Gateway 上运行。

有关两种网关类型的详细信息,请参阅 API Connect 网关类型

下表描述了 execute 字段中可能包含的策略和逻辑构造。

表 1. execute 属性
属性 必需 描述 数据类型 DataPower Gateway 图标 DataPower Gateway 图标
activity-log 可使用 activity-log 策略来记录与 API 操作调用相关的信息。 对象(activity-log Yes Yes

activity-log 扩展提供的功能

gatewayscript 包含 GatewayScript 程序。 对象(gatewayscript Yes Yes

从 V2018.4.1.0 起可用

if 使用 if 策略以仅在满足某个条件时才执行组合件的一部分。 对象(if Yes Yes

从 V2018.4.1.0 起可用,switch 提供的功能

invoke 可使用 invoke 策略来调用 API。

策略中的最后一个调用可能会自动替换为代理,以提高性能。要禁用此功能,请参阅 API 属性

对象(invoke Yes Yes
json-to-xml 将有效内容从 JSON 转换为 XML。 对象(json-to-xml Yes Yes
jwt-generate 生成 JSON Web 令牌 (JWT)。 对象(jwt-generate Yes Yes
jwt-validate 验证 JSON Web 令牌 (JWT)。 对象(jwt-validate Yes Yes
map 使用 map 策略来变换变量。 对象(map Yes Yes
operation-switch 如果要根据调用的操作来执行备用策略组合件,可使用 operation-switch 策略。 对象(operation-switch Yes Yes

从 V2018.4.1.0 起可用,switch 提供的功能

oauth oauth 策略可用于基于定义的 OAuth 提供者设置执行 OAuth 处理。 对象 (oauth) 否 Yes
parse parse 策略可用于控制输入文档的解析。当输入文档为 JSON 字符串时,将解析而非复制该字符串。 对象(parse 否 Yes
proxy 代理服务。 对象(proxy Yes Yes

invoke 提供的功能

redact 可使用 redact 策略来完全移除或编辑请求主体、响应主体和活动日志中的指定字段。如果由于法律、安全性或其他原因而要移除或屏蔽敏感数据(例如,信用卡详细信息),您可能会发现此策略十分有用。 对象(redact Yes 否
set-variable 可使用 set-variable 策略来将运行时变量设置为字符串值,或者添加/清除运行时变量。 对象(set-variable Yes Yes

从 V2018.4.1.0 起可用

switch 使用 switch 策略基于所满足的指定条件执行组合件的众多部分之一。 对象(switch Yes Yes

从 V2018.4.1.0 起可用

throw 使用 throw 策略以指定应抛出错误的点。 对象(throw Yes Yes

从 V2018.4.1.0 起可用

user-defined-policy 您可以将自己的用户定义策略应用于 API。 对象 Yes 否
user-security 抽取用户凭证、对这些凭证进行认证以及获取来自用户的授权。 对象 (user-security) 否 Yes
validate 使用 验证 策略以根据 JSON 或 XML 模式验证组合件流中的有效内容。 对象(validate - DataPower API Gatewayvalidate - DataPower Gateway(与 v5 兼容) Yes Yes

从 V2018.4.1.0 起可用

validate-usernametoken 验证 WS-Security UsernameToken。 对象 (validate-usernametoken) Yes 否
xml-to-json 将有效内容从 XML 转换为 JSON。 对象(xml-to-json Yes Yes
xslt 对有效内容应用 XSLT 变换。 对象(xslt Yes Yes

从 V2018.4.1.0 起可用

以下示例显示调用 URL 然后编辑来自请求或响应的字段的组合件的 execute 字段。

execute:
 - invoke:
  title: Example Invoke
  target-url: 'https://example.com/api'
  description: Example description
 - redact:
  actions:
   - action: redact
     from: 
      - request
      - response
    path: //*[@name='secondaryAddress']/*[@name='streetAddress']
时间戳记图标 上次更新时间:2019-06-21