过滤器是对API生成结果进一步处理的动态函数。您可以通过指定一个或者多个过滤器,加工API的返回结构。本文为您介绍如何创建和使用过滤器,对API返回结果进行二次处理。

前提条件

  • 您需要购买DataWorks专业版及以上版本,才可以使用过滤器和函数功能。
  • 仅华东2(上海)地域支持使用过滤器和函数功能。
过滤器的使用限制如下:
  • 过滤器仅支持Python 3.0的语法。
  • 过滤器仅支持import json,time,random,pickle,re,math
  • 过滤器限定函数名def handler(event,context):

函数结构说明

系统自带的模板函数如下。
# -*- coding: utf-8 -*-

# event (str) : in filter it is the API result, in other cases, it is your param
# context : some environment information, temporarily useless
# import module limit: json,time,random,pickle,re,math
# do not modify function name
import json
def handler(event,context):
# load str to json object
obj = json.loads(event) # 转化为JSON object。
# add your code here
# end add
return obj
您可以基于该函数进行修改,并根据自身需求修改函数的入参名称。
参数1[context]:字符串类型,包含API执行的上下文环境。目前为空,暂未启用。  
参数2[event]:字符串类型,包含API执行的结果,或上一个过滤器处理后的结果。

创建过滤器

  1. 进入数据服务页面。
    1. 登录DataWorks控制台
    2. 在左侧导航栏,单击工作空间列表
    3. 选择工作空间所在地域后,单击相应工作空间后的进入数据服务
  2. 在左侧导航栏,单击函数
  3. 鼠标悬停至新建图标,单击新建Python函数
  4. 新建Python函数对话框中,配置各项参数。
    新建函数
    参数 描述
    函数名称 自定义函数的名称,不能超过256个字符。
    函数模板 仅支持Python3 Standard v1模板。
    运行环境 仅支持Python 3.0。
    函数描述 对函数进行简单描述。
    目标文件夹 存放函数的目录。
  5. 单击确认

使用过滤器

  1. 服务开发页面,双击打开相应的API。
  2. 单击右侧的返回参数
  3. 返回参数 > 高级配置区域,选中使用过滤器
    使用过滤器
  4. 使用过滤器列表中选择相应的函数。
    说明 过滤器由一个或多个函数组成,允许您对API查询结果进行二次处理,您可以新建函数作为过滤器。
  5. 单击结果预览,查看使用过滤器后的数据。