清洗接口

获取清洗应用列表

获取账号下的清洗应用列表。

接口路径

cleaner/list

参数

参数 参数说明
page 获取第几页的应用
page_size 每页多少个

返回示例

{
"code": 0,
"reason": "请求成功",
"data": {
"list": [
{
"app_id": 837545,
"name": "清洗商家数据",
"type": "cleaner",
"status": "stopped",
"count_local": 0,
"time_create": 1512106233
},
{
"app_id": 788194,
"name": "清洗标库网数据",
"type": "cleaner",
"status": "init",
"count_local": 0,
"time_create": 1507884458
},
{
"app_id": 735092,
"name": "清洗淘宝数据",
"type": "cleaner",
"status": "init",
"count_local": 0,
"time_create": 1499234719
}
],
"page": 1,
"total": 3
}
}

创建清洗应用

创建清洗应用。

接口路径

cleaner/create

参数

参数 参数说明
app_name 清洗应用名称,无默认值,必需
app_info 清洗应用描述,无默认值,可选
code 清洗应用代码的base64编码,无默认值,必需

返回示例

{
"code": 0,
"reason": "创建成功",
"data": {
"app_id": 887450,
"name": "rest创建清洗应用",
"status": "init",
"time_create": 1515505215
}
}

删除清洗应用

删除指定清洗应用。

接口路径

cleaner/<清洗应用ID>/delete

参数

返回示例

{
"code": 0,
"reason": "删除成功"
}

修改清洗应用信息

修改清洗应用信息。

接口路径

cleaner/<清洗应用ID>/edit

参数

参数 参数说明
app_name 清洗应用名称,不设置则不修改
app_info 清洗应用描述,不设置则不修改

返回示例

{
"code": 0,
"reason": "修改成功"
}

设置代理

修改清洗应用的代理设置。

接口路径

cleaner/<清洗应用ID>/config/proxy

参数

参数 参数说明
proxy_type 代理IP类型,0-不使用代理IP,3-企业级专属代理IP,4-海外私密代理IP

返回示例

{
"code": 0,
"reason": "设置成功"
}

配置文件云托管

修改清洗应用的文件云托管设置。

接口路径

cleaner/<清洗应用ID>/config/host

参数

参数 参数说明
host_type 托管类型,0-不托管,1-阿里云OSS,2-七牛云存储,3-神箭手,4-又拍云
image 是否托管图片类型的文件,true和非零数字都表示托管,不传表示不托管
text 是否托管文本类型的文件,值同上
audio 是否托管音频类型的文件,值同上
video 是否托管视频类型的文件,值同上
application 是否托管应用类型的文件,值同上

返回示例

{
"code": 0,
"reason": "设置成功"
}

设置输入数据源和输出数据源

设置清洗应用的输入数据源和输出数据源。

接口路径

cleaner/<清洗应用ID>/config/source

参数

返回示例

启动

启动指定的清洗应用。

接口路径

cleaner/<清洗应用ID>/start

参数

参数 参数说明
node 使用节点数,默认值1

返回示例

{
"code": 0,
"reason": "启动成功",
"data": {
"status": "starting"
}
}

停止

停止指定的清洗应用。

接口路径

cleaner/<清洗应用ID>/stop

参数

返回示例

{
"code": 0,
"reason": "停止成功",
"data": {
"status": "stopping"
}
}

暂停

暂停指定的清洗应用。

接口路径

cleaner/<清洗应用ID>/pause

参数

返回示例

{
"code": 0,
"reason": "暂停成功",
"data": {
"status": "pausing"
}
}

继续

恢复运行指定的清洗应用。

接口路径

cleaner/<清洗应用ID>/resume

参数

返回示例

{
"code": 0,
"reason": "继续成功",
"data": {
"status": "resuming"
}
}

获取Webhook

获取清洗应用的Webhook信息。

接口路径

cleaner/<清洗应用ID>/webhook/get

参数

返回示例

{
"code": 0,
"reason": "请求成功",
"data": {
"url": "http://webhook.shenjian.io/receive",
"label": [
"新增数据",
"变动数据"
],
"gzip": false
}
}

设置Webhook

设置清洗应用的Webhook。

接口路径

cleaner/<清洗应用ID>/webhook/set

参数

参数 参数说明
url webhook的通知地址,需要是能外网访问的地址
data_new 新增数据是否发送webhook,true和非零数字都表示发送,不传表示不发送
data_updated 变动数据是否发送webhook,值同上
msg_custom 自定义消息是否发送webhook,值同上
gzip 是否对webhook数据进行gzip压缩,true和非零数字都表示压缩,不传表示不压缩

返回示例

{
"code": 0,
"reason": "设置成功"
}

删除Webhook

删除清洗应用的Webhook。

接口路径

cleaner/<清洗应用ID>/webhook/delete

参数

返回示例

{
"code": 0,
"reason": "删除成功"
}