文档首页/ 推荐系统 RES/ API参考/ API（V1不推荐）/ 作业相关API/ 提交过滤作业
更新时间：2023-05-24 GMT+08:00
查看PDF
分享

提交过滤作业

功能介绍

该接口用于提交过滤作业并进行离线计算。

URI

POST /v1/{project_id}/filter-job

参数说明请参见表1。

表1 URI参数说明

名称

是否必选

类型

说明

project_id

是

String

项目编号，用于资源隔离。获取方法请参见获取项目ID。

请求消息

请求参数请参见表2。

表2 请求参数说明

参数名称

是否必选

参数类型

说明

workspace_id

否

String

工作空间ID，默认为0。

job_name

是

String

训练作业名称，最大长度为20。

job_description

否

String

训练作业描述，最大长度为256。

offline_platform

是

JSON

请参见表3，离线计算平台信息。

storage

是

JSON

请参见表8，信息存储。

filter_rules

否

JSON

过滤配置列表。
表3 offline_platform参数说明

参数名称

是否必选

参数类型

说明

platform

是

String

平台名称，最大长度64，支持DLI。

platform_parameter

是

JSON

请参见表4，平台参数。

computing_resource

否

String

指定DLI运行任务的资源规格。

config_load_path

是

String

所选配置生成的文件在OBS上的存储路径。
表4 platform_parameter参数说明

参数名称

是否必选

参数类型

说明

cluster_name

是

String

集群名称。

cluster_id

否

String

集群ID。
表5 filter_rules参数说明

参数名称

是否必选

参数类型

说明

name

是

String

过滤名称。

behavior_rules

否

List

请参见表13，用户行为过滤配置。

说明：

过滤策略请至少选择behavior_rules、property_rules、blacklist、whitelist中的一个作为过滤条件。

blacklist

否

String

黑名单过滤配置。

whitelist

否

String

白名单过滤配置。

data_source

否

List

请参见表6，数据源。

响应消息

响应参数请参见表6。

表6 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

是

Boolean

是否成功。

job_id

是

String

作业ID。

filter_uuid

是

String

过滤规则生成的uuid。

示例

  • 请求示例 
    {
	"job_name": "dd",
	"job_desc": "ff",
	"offline_platform": {
		"platform": "DLI",
		"platform_parameter": {
			"cluster_name": "res_cluster"
		},
		"config_load_path": "<配置生成的文件在OBS上的存储路径>"
	},
	"storage": {
		"platform": "CloudTable",
		"platform_parameter": {
			"cluster_name": "cloudtable-e596",
			"cluster_id": "ec55161b-06e3-4871-af2a-2a6ec29e60f3",
			"table_name": "res_yang0918"
		}
	},
	"filter_rules": {
                "name":"过滤名称",
		"behavior_rules": [{
			"behavior_type": "view",
			"interval": 7,
			"frequency": 5
		}],
		"property_rules": [{
			"user_properties": [{
				"name": "provinceId",
				"value": "4261.0"
			}],
			"item_properties": [{
				"name": "weight",
				"value": "0.00"
			}]
		}],
                "etl_uuid": "4934b7757e1b404eafcb26c6284e2696",
		"data_source": [{
			"table_type_id": "ITEM_META",
			"data_format": "csv",
			"data_source_url": "<数据源存储路径>",
			"data_param": {
				"header": "false",
				"delimiter": ",",
				"quote": "\"",
				"escape": "\\"
			}
		}, {
			"table_type_id": "ITEM_META_CONF",
			"data_format": "csv",
			"data_source_url": "<数据源存储路径>",
			"data_param": {
				"header": "false",
				"delimiter": ",",
				"quote": "\"",
				"escape": "\\"
			}
		}, {
			"table_type_id": "USER_BEHAVIOR",
			"data_format": "csv",
			"data_source_url": "<数据源存储路径>",
			"data_param": {
				"header": "false",
				"delimiter": ",",
				"quote": "\"",
				"escape": "\\"
			}
		}],
		"blacklist": "<黑名单存储路径>",
		"whitelist": "<白名单存储路径>"
	}
}
  • 成功响应示例 
    {
    "is_success": true,
    "job_id": "242040859dd4422d818efe7c297f1b66",
    "filter_uuid": "5666556ad3814f358a786eb6efcfe1ec"
}
  • 失败响应示例 
    {
    "is_success": false,
    "error_code": "res.1008",
    "error_msg": "The request parameter(job_name) is null."
}

状态码

状态码请参见状态码。

父主题： 作业相关API

相关文档