全部产品
Search
文档中心

大数据开发治理平台 DataWorks:配置API过滤器(函数)

更新时间:Dec 05, 2024

数据服务支持您编写函数,并将函数关联至API,使得函数可以作为API的过滤器使用,对API的请求参数或返回结果进行加工处理。本文为您介绍函数功能。

使用限制

  • 您需要购买DataWorks基础版及以上版本,才可以使用过滤器功能。

  • Python函数正在改造中,暂不支持新建、克隆和发布新的Python函数。如需使用函数作为API过滤器,建议您使用Aviator函数类型。详情请参见创建Aviator函数

注意事项

  • 当使用函数作为API过滤器时,前置过滤器和后置过滤器的函数类型需要保持一致,即均选择Aviator函数类型或Python函数类型。暂不支持对同一API的前置和后置过滤器选择不同的函数类型。

  • 基于安全和性能等因素的评估,Aviator函数需要运行在独享数据服务资源组中。

    • 当您编辑、测试函数时,需要对函数绑定独享数据服务资源组。详情请参见创建函数

    • 当您在API开发时启用了过滤器并关联了目标函数,需要对API绑定独享数据服务资源组。详情请参见通过向导模式生成API

功能介绍

数据服务支持的函数类型包括Aviator函数、Python函数,您可以在数据服务中创建函数测试函数发布函数,发布后的函数可被进一步关联至API,作为API的过滤器,对API的请求参数或返回结果进行加工处理,从而实现API的复杂查询需求,灵活适配各类业务场景。详情请参见使用函数作为API过滤器

  • 如果将函数设置为API的前置过滤器,当API被调用时,函数可以对API的请求参数进行预先处理。

  • 如果将函数设置为API的后置过滤器,当API被调用时,函数可以对API的返回结果进行二次加工和改造。

常见场景的代码示例请参见:使用Aviator函数作为过滤器的最佳实践