华为云用户手册

请求示例 同时新建作业多个 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/job-instances[ { "job_name" : "WriteItemProfile-test", "description" : "item", "category" : "DATASOURCE", "job_type" : "WriteItemProfile", "job_config" : { }}, { "job_name" : "EncodeProfile-test", "description" : "universal", "category" : "SORTING", "job_type" : "EncodeProfile", "job_config" : { }} ]

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 内容类型，包括application和json两种类型 X-Auth-Token 是 String 用户token，获取方式请参见获取用户Token 表3 请求Body参数 参数 是否必选 参数类型 描述 category 是 String 类别： RECALL，召回作业 DATASOURCE，数据源作业 FILTER，过滤作业 SORTING，排序作业 EVALUATE，效果评估作业 description 否 String 描述 job_config 是 jobConfig object 作业配置 exec_config 否 ResExecConfig object 作业执行配置项（仅离线任务可提供此配置） job_name 是 String 作业名称，1-64位字母、数字、下划线、中划线组合 job_type 是 String 作业类型： WriteUserProfile，用户画像实时导入作业 WriteItemProfile，物品画像实时导入作业 UniversalProcess，行为数据实时导入作业 NearlineRecall，近线召回作业 EncodeProfile，近线特征工程作业 AttributeMatch，属性匹配召回作业 AlsCF，交替最小二乘协同过滤作业 BhvHistory，历史行为记忆召回作业 ItemCf，物品协同过滤召回作业 MenEdit，人工配置候选集作业 Ucb，UCB召回作业 UserCf，用户协同过滤召回作业 WeightBehavior，综合行为热度召回作业 Filter，历史行为过滤作业 AutoPreRank，智能ETL参数生成作业 ETL，离线特征工程作业 LR，LR作业 DEEPFM，DEEPFM作业 AutoGroup，AutoGroup作业 StreamRank，在线训练作业 DataStruct，识别数据结构作业 DataExploration，数据探索作业 DataImport，离线数据导入作业 Evaluate，效果评估作业 schedule 否 String 调度参数 表4 jobConfig 参数 是否必选 参数类型 描述 nearline_recall_param 否 NearLineRecallParam object 近线召回作业参数（近线召回作业需要提供此参数）。 max_recommended_num 否 Integer 最大候选集个数（所有召回作业需提供此参数）。 最小值：1 最大值：200 match_feature_pairs 否 Array of MatchFeaturePair objects 匹配特征对（属性匹配召回作业需要提供此参数）。 striping 否 Striping object 行条化策略（属性匹配召回作业、物品协同过滤召回作业、用户协同过滤召回作业需要提供此参数）。 match_type 否 String 匹配类型（属性匹配召回作业需提供此参数）： UI，基于用户推荐物品 UU，基于用户推荐用户 II，基于物品推荐物品 IU，基于物品推荐用户 matrix_factorization 否 MatrixFactorization object 矩阵分解参数配置（交替最小二乘协同过滤作业需提供此参数）。 behavior_frequencys 否 Array of BehaviorFrequency objects 行为频率信息（历史行为记忆召回作业、历史行为过滤作业需提供此参数）。 file_path 否 String 文件路径（人工配置候选集作业需要提供此参数）。 ucb_param 否 UcbParam object UCB作业参数（UCB召回作业需要提供此参数）。 behavior_gravity 否 BehaviorGravity object 重力衰减因子（综合行为热度召回作业需要提供此参数）。 category 否 Category object 类别（综合行为热度召回作业需要提供此参数）。 behavior_logic 否 String 行为逻辑过滤（历史行为过滤作业需提供此参数）： AND，同时满足则过滤 OR， 满足一个则过滤 features_engineering 否 EtlBasicParameter object 特征参数（离线特征工程作业需要提供此参数）。 sample_param 否 SampleParam object 样本参数（离线特征工程作业需要提供此参数）。 deep_learning_parameters 否 DeepLearingParam object 排序作业通用参数（LR、DEEPFM、AutoGroup需要提供此参数）。 algorithm_specify_parameters 否 AlgorithmSpecifyParameters object 排序算法特定参数（LR、DEEPFM、AutoGroup需要提供此参数）。 load_widetable 否 Boolean 导入宽表（离线数据导入作业需要提供此参数）。 load_profile 否 Boolean 导入画像（离线数据导入作业需要提供此参数）。 save_mode 否 String 保留已有宽表（离线数据导入作业需要提供此参数）： append，是 new，否 overwirte，覆盖 indicators 否 Array of Indicator objects 统计指标（效果评估作业需要提供此参数）。 offline_rank_job_name 否 String 离线排序作业名称（在线训练任务需要提供此参数）。 update_interval 否 Integer 更新周期（在线训练任务需要提供此参数）。 optimizer 否 Optimizer object 优化器（在线训练任务需要提供此参数）。 flows 否 Flow object 在线流程（在线训练任务需要提供此参数）。 表5 NearLineRecallParam 参数 是否必选 参数类型 描述 time_limit 否 Boolean 时间过滤。 timeFeature 否 String 时间特征。 retainDays 否 Integer 保留期(天)。 recall_fileds 否 Array of RecallFiled objects 召回字段。 itemCF_job_name 否 String 物品协同过滤作业名称。 表6 RecallFiled 参数 是否必选 参数类型 描述 name 否 String 字段名称。 value 否 Integer 使用字段值的个数。 最小值：1 最大值：10 缺省值：1 表7 MatchFeaturePair 参数 是否必选 参数类型 描述 user_feature_name 否 String 用户特征。 item_feature_name 否 String 物品特征。 weight 否 Double 权重。 match_count 否 Boolean 匹配个数度量。 表8 Striping 参数 是否必选 参数类型 描述 nearest_neighborhood 是 Integer 最近领域个数。 band 是 Integer 相似程度。 最小值：1 最大值：20 row 是 Integer 相似距离。 最小值：1 最大值：10 表9 MatrixFactorization 参数 是否必选 参数类型 描述 implicit_vector_rank 是 Integer 隐向量维度。 最小值：1 最大值：100 regular_param 是 Double 优化正则化系数。 最小值：1.0E-8 最大值：1 max_iterator_num 是 Integer 迭代次数。 最小值：1 最大值：50 表10 BehaviorFrequency 参数 是否必选 参数类型 描述 behavior_type 是 String 行为类型： view，曝光 click，点击 collect，收藏 uncollect，取消收藏 search_click，搜索后点击 comment，评论 share，分享 like，点赞 dislike，点衰 grade，评分 consume，消费 use，观看视频/听音乐/阅读 download，下载 tip，打赏 subscribe，关注 lower_limit 否 Integer 最小次数。 最小值：1 upper_limit 否 Integer 最大次数。 最小值：1 time_interval 是 Integer 时间区间。 最小值：1 表11 UcbParam 参数 是否必选 参数类型 描述 alpha 是 Double 折中参数。 最小值：0 最大值：1 min_used_num 是 Integer 最小行为次数。 最小值：30 最大值：1000 表12 BehaviorGravity 参数 是否必选 参数类型 描述 weaken_factor 否 Double 衰减因子。 最小值：0.1 最大值：5 view_type 否 String 行为次数统计方法： pv，访问量 uv，独立访客 algo_type 否 String 算法类型: normal，通用 time，时间 表13 Category 参数 是否必选 参数类型 描述 user_meta_list 否 Array of strings 用户特征。 item_meta_list 否 Array of strings 物品特征。 表14 EtlBasicParameter 参数 是否必选 参数类型 描述 user_features 否 Array of FeatureTransformation objects 用户特征。 item_features 否 Array of FeatureTransformation objects 物品特征。 rank_etl_filter 否 RankETLFilter object 过滤参数。 表15 FeatureTransformation 参数 是否必选 参数类型 描述 attr 否 Attribute object 特征。 discrete_method 否 String 离散方法： equal_distance_discrete，等距离散 user_define_discrete，自定义离散 normalize，归一化 null，不离散 params 否 Object 具体处理参数。 表16 Attribute 参数 是否必选 参数类型 描述 name 是 String 名称。 data_type 否 String 数据类型。 other_uses 否 Array of strings 其他用途。 表17 RankETLFilter 参数 是否必选 参数类型 描述 filter_type 是 String 行为去重方式： abs_weight，权重绝对值 date，日期 time_type 是 String 时间类型： day，天 week，周 month，月 is_monday_first 否 Boolean 周一是否是第一天。 表18 SampleParam 参数 是否必选 参数类型 描述 divide_type 是 String 训练集测试集划分方式： TIME，时间比例 RAM DOM，个数比例 train_rate 否 Double 训练数据占比。 最小值：0.01 最大值：1 test_rate 否 Double 测试数据占比。 最小值：0.01 最大值：1 表19 DeepLearingParam 参数 是否必选 参数类型 描述 initial_parameters 否 Initial object 初始化参数。 optimize_parameters 否 Optimizer object 优化参数。 regular_parameters 否 Regular object 正则化参数。 max_iterations 否 Integer 最大迭代轮数。 最小值：1 最大值：1000 early_stop_iterations 否 Integer 提前终止训练轮数。 最小值：1 最大值：1000 batch_size 否 Integer 批量大小。 最小值：1 dataset_split_parts 否 Integer 训练数据集切分数量。 最小值：1 最大值：10 restart_train 否 Boolean 重新训练。 表20 Initial 参数 是否必选 参数类型 描述 initial_method 是 String 初始化方法。 mean_value 否 Double 平均值。 最小值：-1 最大值：1 standard_deviation 否 Double 标准差。 最小值：0 最大值：1 min_value 否 Double 最小值。 最小值：-1 最大值：0 max_value 否 Double 最大值。 最小值：0 最大值：1 表21 Optimizer 参数 是否必选 参数类型 描述 type 否 String 优化器类型。 learning_rate 否 Double 学习率。 initial_accumulator_value 否 Double 初始梯度累加和。 最小值：0 最大值：1 lambda1 否 Double L1正则项系数。 最小值：0 最大值：1 lambda2 否 Double L2正则项系数。 最小值：0 最大值：1 epsilon 否 Double 数值稳定常量。 最小值：0 最大值：1 decay_rate 否 Double 衰减因子。 最小值：0 最大值：1 decay_steps 否 Double 衰减步长。 最小值：1 表22 Regular 参数 是否必选 参数类型 描述 l2_regularization 否 Double L2正则项系数。 最小值：0 最大值：1 regular_loss_compute_mode 否 String 正则损失计算方式。 embed_l2_regularization 否 Double 隐向量层L2正则化系数。 最小值：0 最大值：1 wide_l2_regularization 否 Double wide部分L2正则化系数。 最小值：0 最大值：1 structure_l2_regularization 否 Double 结构化部分L2正则化系数。 最小值：0 最大值：1 表23 AlgorithmSpecifyParameters 参数 是否必选 参数类型 描述 latent_vector_length 否 Integer 隐向量长度(DEEPFM需要提供此参数)。 最小值：1 最大值：100 architecture 否 Array of integers 神经网络结构(DEEPFM需要提供此参数)。 active_function 否 String 激活函数(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 value_keep_probability 否 Double 神经元值保留概率(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 最小值：0 最大值：1 embed_size 否 Array of integers 各阶隐向量长度(AutoGroup需要提供此参数)。 mlp_architecture 否 Array of integers 神经网络结构(AutoGroup需要提供此参数)。 max_order 否 Integer 最大交互阶数(AutoGroup需要提供此参数)。 hash_sizes 否 Array of integers 哈希长度(AutoGroup需要提供此参数)。 hash_compensation 否 Array of numbers 特征交互层惩罚项系数(AutoGroup需要提供此参数)。 use_wide_part 否 Boolean 使用线性部分(AutoGroup需要提供此参数)。 structure_optimizer 否 Optimizer object 优化器参数(AutoGroup需要提供此参数)。 merge_multi_hot 否 Boolean 融合多值特征(AutoGroup需要提供此参数)。 fix_structure 否 Boolean 固定哈希结构(AutoGroup需要提供此参数)。 表24 Indicator 参数 是否必选 参数类型 描述 indicator_name 否 String 指标名称： clickPVRate，点击PV率 clickUVRate，点击UV率 customize，自定义 indicator_params 否 IndicatorParam object 指标参数（自定义指标需要提供）。 表25 IndicatorParam 参数 是否必选 参数类型 描述 customize_parameter 否 CustomizeParameter object 自定义参数。 customize_formula 否 CustomizeFormula object 自定义公式。 表26 CustomizeParameter 参数 是否必选 参数类型 描述 alias 是 String 别名。 behavior_type 是 String 行为类型。 threshold 否 Double 阈值。 最小值：0 最大值：1 deduplication 是 String 去重。 表27 CustomizeFormula 参数 是否必选 参数类型 描述 alias 否 String 别名。 formula 否 String 公式。 表28 Flow 参数 是否必选 参数类型 描述 flow_id 是 String 流程id。 attr_pair_rules_filter 否 Array of AttrPairRules objects 属性对过滤。 attr_pair_rules_reserve 否 Array of AttrPairRules objects 属性对保留。 deduplication_list 否 Array of Deduplication objects 属性去重。 attribute_info 否 AttributeInfo object 综合排序信息。 bloom_filter_conf 否 BloomFilterConf object 布隆过滤器配置。 group_attr 否 String 分组打散属性。 pre_deal 否 Boolean 在排序前去重。 rank_setting 否 String 排序配置信息。 rules 否 Rule object 候选集融合。 filter_sets 否 Array of strings 过滤配置信息。 attr_value_rules_filter 否 Array of AttrValueRules objects 属性值过滤。 attr_value_rules_reserve 否 Array of AttrValueRules objects 属性值保留。 ctr_job 否 String 排序作业（使用点击率预估时需要提供此参数）。 ratio 否 Integer 流量占比。 最小值：1 最大值：100 toppings 否 Array of strings 需要置顶的候选集列表。 表29 AttrPairRules 参数 是否必选 参数类型 描述 attr_pairs 否 Array of AttrPair objects 属性对。 表30 AttrPair 参数 是否必选 参数类型 描述 party_a 否 String 被推荐对象的属性名。 party_b 否 String 被推荐对象的属性名。 表31 Deduplication 参数 是否必选 参数类型 描述 attributes 否 Array of strings 属性。 表32 AttributeInfo 参数 是否必选 参数类型 描述 rank_feature_pairs 否 Array of RankFeaturePair objects 属性匹配对。 numerical_attrs 否 Array of NumericalAttr objects 属性权重。 num_statistics_type 否 String 统计方式： ORDER，顺序 ABS，绝对值 表33 RankFeaturePair 参数 是否必选 参数类型 描述 feature_name_a 否 String 待推荐对象的属性。 feature_name_b 否 String 被推荐对象的属性。 weight 否 Float 权重。 最小值：0.01 最大值：1 表34 NumericalAttr 参数 是否必选 参数类型 描述 name 是 String 特征名。 weight 是 Float 权重。 最小值：0.001 最大值：1 表35 BloomFilterConf 参数 是否必选 参数类型 描述 behaviors 否 Array of strings 待过滤行为类型。 interval 否 Integer 过滤时间。 最小值：1 最大值：7 表36 Rule 参数 是否必选 参数类型 描述 table_name 是 String 候选集表名。 rule_ratio 是 Integer 规则占比。 最小值：1 最大值：100 priority 是 Integer 优先级。 最小值：1 最大值：10 表37 AttrValueRules 参数 是否必选 参数类型 描述 attr_values_a 否 Array of AttrValue objects 被推荐对象的属性-值配置。 attr_values_b 是 Array of AttrValue objects 待推荐对象的属性-值配置。 表38 AttrValue 参数 是否必选 参数类型 描述 name 是 String 属性名称。 value 是 String 属性值。 表39 ResExecConfig 参数 是否必选 参数类型 描述 spark_calc_spec 否 SparkCalcSpec object spark自定义计算规格 spark_option_confs 否 Array of SparkOptionConf objects spark可选配置项 表40 SparkCalcSpec 参数 是否必选 参数类型 描述 driver_memory 是 String driver内存 driver_cores 是 Integer driver核数 executor_memory 是 String executor内存 executor_cores 是 Integer executor核数 num_executors 是 Integer executor个数 表41 SparkOptionConf 参数 是否必选 参数类型 描述 name 否 String 参数名称 value 否 String 参数值

URI POST /v2.0/{project_id}/workspaces/{workspace_id}/resources/{resource_id}/job-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方式请参见获取项目ID resource_id 是 String 资源id workspace_id 是 String 工作空间id

响应示例 状态码： 200 OK { "job" : { "category" : "SERVICE", "job_name" : "online1", "job_id" : "testuuidxxxxxxxxxxxxxxxxxxxxxxxx", "description" : "inference service", "job_type" : "infer", "status" : "Draft", "platform" : "AIP", "workspace_id" : "testuuidxxxxxxxxxxxxxxxxxxxxxxxx", "resource_id" : "testuuidxxxxxxxxxxxxxxxxxxxxxxxx" }, "is_success" : true}

请求示例 发布推理服务 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/service-instance{ "category" : "SERVICE", "job_type" : "infer", "job_config" : { "flows" : [ { "ratio" : 100, "rules" : [ { "table_name" : "item-UIREC", "rule_ratio" : 100, "priority" : "1" } ], "flow_id" : "flow1" } ] }, "description" : "inference service", "job_name" : "online1"}

响应参数 状态码： 200 表39 响应Body参数 参数 参数类型 描述 is_success Boolean 是否成功 job jobs object 服务描述信息 message String 返回消息（请求成功时，不返回此字段） error_code String 错误码（请求成功时，不返回此字段） 表40 jobs 参数 参数类型 描述 category String 类别。 config_info String 配置信息。 description String 描述。 job_id String 作业id。 job_name String 作业名称。 job_type String 作业类型。 next_schedule_time Integer 下次调度时间。 platform String 平台。 resource_id String 资源id。 schedule String 调度参数。 status String 状态。 workspace_id String 工作空间id。 job_config jobConfig object 作业配置。 表41 jobConfig 参数 参数类型 描述 nearline_recall_param NearLineRecallParam object 近线召回作业参数（近线召回作业需要提供此参数）。 max_recommended_num Integer 最大候选集个数（所有召回作业需提供此参数）。 最小值：1 最大值：200 match_feature_pairs Array of MatchFeaturePair objects 匹配特征对（属性匹配召回作业需要提供此参数）。 striping Striping object 行条化策略（属性匹配召回作业、物品协同过滤召回作业、用户协同过滤召回作业需要提供此参数）。 match_type String 匹配类型（属性匹配召回作业需提供此参数）： UI，基于用户推荐物品 UU，基于用户推荐用户 II，基于物品推荐物品 IU，基于物品推荐用户 matrix_factorization MatrixFactorization object 矩阵分解参数配置（交替最小二乘协同过滤作业需提供此参数）。 behavior_frequencys Array of BehaviorFrequency objects 行为频率信息（历史行为记忆召回作业、历史行为过滤作业需提供此参数）。 file_path String 文件路径（人工配置候选集作业需要提供此参数）。 ucb_param UcbParam object UCB作业参数（UCB召回作业需要提供此参数）。 behavior_gravity BehaviorGravity object 重力衰减因子（综合行为热度召回作业需要提供此参数）。 category Category object 类别（综合行为热度召回作业需要提供此参数）。 behavior_logic String 行为逻辑过滤（历史行为过滤作业需提供此参数）： AND，同时满足则过滤 OR， 满足一个则过滤 features_engineering EtlBasicParameter object 特征参数（离线特征工程作业需要提供此参数）。 sample_param SampleParam object 样本参数（离线特征工程作业需要提供此参数）。 deep_learning_parameters DeepLearingParam object 排序作业通用参数（LR、DEEPFM、AutoGroup需要提供此参数）。 algorithm_specify_parameters AlgorithmSpecifyParameters object 排序算法特定参数（LR、DEEPFM、AutoGroup需要提供此参数）。 load_widetable Boolean 导入宽表（离线数据导入作业需要提供此参数）。 load_profile Boolean 导入画像（离线数据导入作业需要提供此参数）。 save_mode String 保留已有宽表（离线数据导入作业需要提供此参数）： append，是 new，否 overwirte，覆盖 indicators Array of Indicator objects 统计指标（效果评估作业需要提供此参数）。 offline_rank_job_name String 离线排序作业名称（在线训练任务需要提供此参数）。 update_interval Integer 更新周期（在线训练任务需要提供此参数）。 optimizer Optimizer object 优化器（在线训练任务需要提供此参数）。 flows Flow object 在线流程（在线训练任务需要提供此参数）。 表42 NearLineRecallParam 参数 参数类型 描述 time_limit Boolean 时间过滤。 timeFeature String 时间特征。 retainDays Integer 保留期(天)。 recall_fileds Array of RecallFiled objects 召回字段。 itemCF_job_name String 物品协同过滤作业名称。 表43 RecallFiled 参数 参数类型 描述 name String 字段名称。 value Integer 使用字段值的个数。 最小值：1 最大值：10 缺省值：1 表44 MatchFeaturePair 参数 参数类型 描述 user_feature_name String 用户特征。 item_feature_name String 物品特征。 weight Double 权重。 match_count Boolean 匹配个数度量。 表45 Striping 参数 参数类型 描述 nearest_neighborhood Integer 最近领域个数。 band Integer 相似程度。 最小值：1 最大值：20 row Integer 相似距离。 最小值：1 最大值：10 表46 MatrixFactorization 参数 参数类型 描述 implicit_vector_rank Integer 隐向量维度。 最小值：1 最大值：100 regular_param Double 优化正则化系数。 最小值：1.0E-8 最大值：1 max_iterator_num Integer 迭代次数。 最小值：1 最大值：50 表47 BehaviorFrequency 参数 参数类型 描述 behavior_type String 行为类型： view，曝光 click，点击 collect，收藏 uncollect，取消收藏 search_click，搜索后点击 comment，评论 share，分享 like，点赞 dislike，点衰 grade，评分 consume，消费 use，观看视频/听音乐/阅读 download，下载 tip，打赏 subscribe，关注 lower_limit Integer 最小次数。 最小值：1 upper_limit Integer 最大次数。 最小值：1 time_interval Integer 时间区间。 最小值：1 表48 UcbParam 参数 参数类型 描述 alpha Double 折中参数。 最小值：0 最大值：1 min_used_num Integer 最小行为次数。 最小值：30 最大值：1000 表49 BehaviorGravity 参数 参数类型 描述 weaken_factor Double 衰减因子。 最小值：0.1 最大值：5 view_type String 行为次数统计方法： pv，访问量 uv，独立访客 algo_type String 算法类型: normal，通用 time，时间 表50 Category 参数 参数类型 描述 user_meta_list Array of strings 用户特征。 item_meta_list Array of strings 物品特征。 表51 EtlBasicParameter 参数 参数类型 描述 user_features Array of FeatureTransformation objects 用户特征。 item_features Array of FeatureTransformation objects 物品特征。 rank_etl_filter RankETLFilter object 过滤参数。 表52 FeatureTransformation 参数 参数类型 描述 attr Attribute object 特征。 discrete_method String 离散方法： equal_distance_discrete，等距离散 user_define_discrete，自定义离散 normalize，归一化 null，不离散 params Object 具体处理参数。 表53 Attribute 参数 参数类型 描述 name String 名称。 data_type String 数据类型。 other_uses Array of strings 其他用途。 表54 RankETLFilter 参数 参数类型 描述 filter_type String 行为去重方式： abs_weight，权重绝对值 date，日期 time_type String 时间类型： day，天 week，周 month，月 is_monday_first Boolean 周一是否是第一天。 表55 SampleParam 参数 参数类型 描述 divide_type String 训练集测试集划分方式： TIME，时间比例 RAMDOM，个数比例 train_rate Double 训练数据占比。 最小值：0.01 最大值：1 test_rate Double 测试数据占比。 最小值：0.01 最大值：1 表56 DeepLearingParam 参数 参数类型 描述 initial_parameters Initial object 初始化参数。 optimize_parameters Optimizer object 优化参数。 regular_parameters Regular object 正则化参数。 max_iterations Integer 最大迭代轮数。 最小值：1 最大值：1000 early_stop_iterations Integer 提前终止训练轮数。 最小值：1 最大值：1000 batch_size Integer 批量大小。 最小值：1 dataset_split_parts Integer 训练数据集切分数量。 最小值：1 最大值：10 restart_train Boolean 重新训练。 表57 Initial 参数 参数类型 描述 initial_method String 初始化方法。 mean_value Double 平均值。 最小值：-1 最大值：1 standard_deviation Double 标准差。 最小值：0 最大值：1 min_value Double 最小值。 最小值：-1 最大值：0 max_value Double 最大值。 最小值：0 最大值：1 表58 Optimizer 参数 参数类型 描述 type String 优化器类型。 learning_rate Double 学习率。 initial_accumulator_value Double 初始梯度累加和。 最小值：0 最大值：1 lambda1 Double L1正则项系数。 最小值：0 最大值：1 lambda2 Double L2正则项系数。 最小值：0 最大值：1 epsilon Double 数值稳定常量。 最小值：0 最大值：1 decay_rate Double 衰减因子。 最小值：0 最大值：1 decay_steps Double 衰减步长。 最小值：1 表59 Regular 参数 参数类型 描述 l2_regularization Double L2正则项系数。 最小值：0 最大值：1 regular_loss_compute_mode String 正则损失计算方式。 embed_l2_regularization Double 隐向量层L2正则化系数。 最小值：0 最大值：1 wide_l2_regularization Double wide部分L2正则化系数。 最小值：0 最大值：1 structure_l2_regularization Double 结构化部分L2正则化系数。 最小值：0 最大值：1 表60 AlgorithmSpecifyParameters 参数 参数类型 描述 latent_vector_length Integer 隐向量长度(DEEPFM需要提供此参数)。 最小值：1 最大值：100 architecture Array of integers 神经网络结构(DEEPFM需要提供此参数)。 active_function String 激活函数(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 value_keep_probability Double 神经元值保留概率(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 最小值：0 最大值：1 embed_size Array of integers 各阶隐向量长度(AutoGroup需要提供此参数)。 mlp_architecture Array of integers 神经网络结构(AutoGroup需要提供此参数)。 max_order Integer 最大交互阶数(AutoGroup需要提供此参数)。 hash_sizes Array of integers 哈希长度(AutoGroup需要提供此参数)。 hash_compensation Array of numbers 特征交互层惩罚项系数(AutoGroup需要提供此参数)。 use_wide_part Boolean 使用线性部分(AutoGroup需要提供此参数)。 structure_optimizer Optimizer object 优化器参数(AutoGroup需要提供此参数)。 merge_multi_hot Boolean 融合多值特征(AutoGroup需要提供此参数)。 fix_structure Boolean 固定哈希结构(AutoGroup需要提供此参数)。 表61 Indicator 参数 参数类型 描述 indicator_name String 指标名称： clickPVRate，点击PV率 clickUVRate，点击UV率 customize，自定义 indicator_params IndicatorParam object 指标参数（自定义指标需要提供）。 表62 IndicatorParam 参数 参数类型 描述 customize_parameter CustomizeParameter object 自定义参数。 customize_formula CustomizeFormula object 自定义公式。 表63 CustomizeParameter 参数 参数类型 描述 alias String 别名。 behavior_type String 行为类型。 threshold Double 阈值。 最小值：0 最大值：1 deduplication String 去重。 表64 CustomizeFormula 参数 参数类型 描述 alias String 别名。 formula String 公式。 表65 Flow 参数 参数类型 描述 flow_id String 流程id。 attr_pair_rules_filter Array of AttrPairRules objects 属性对过滤。 attr_pair_rules_reserve Array of AttrPairRules objects 属性对保留。 deduplication_list Array of Deduplication objects 属性去重。 attribute_info AttributeInfo object 综合排序信息。 bloom_filter_conf BloomFilterConf object 布隆过滤器配置。 group_attr String 分组打散属性。 pre_deal Boolean 在排序前去重。 rank_setting String 排序配置信息。 rules Rule object 候选集融合。 filter_sets Array of strings 过滤配置信息。 attr_value_rules_filter Array of AttrValueRules objects 属性值过滤。 attr_value_rules_reserve Array of AttrValueRules objects 属性值保留。 ctr_job String 排序作业（使用点击率预估时需要提供此参数）。 ratio Integer 流量占比。 最小值：1 最大值：100 toppings Array of strings 需要置顶的候选集列表。 表66 AttrPairRules 参数 参数类型 描述 attr_pairs Array of AttrPair objects 属性对。 表67 AttrPair 参数 参数类型 描述 party_a String 被推荐对象的属性名。 party_b String 被推荐对象的属性名。 表68 Deduplication 参数 参数类型 描述 attributes Array of strings 属性。 表69 AttributeInfo 参数 参数类型 描述 rank_feature_pairs Array of RankFeaturePair objects 属性匹配对。 numerical_attrs Array of NumericalAttr objects 属性权重。 num_statistics_type String 统计方式： ORDER，顺序 ABS，绝对值 表70 RankFeaturePair 参数 参数类型 描述 feature_name_a String 待推荐对象的属性。 feature_name_b String 被推荐对象的属性。 weight Float 权重。 最小值：0.01 最大值：1 表71 NumericalAttr 参数 参数类型 描述 name String 特征名。 weight Float 权重。 最小值：0.001 最大值：1 表72 BloomFilterConf 参数 参数类型 描述 behaviors Array of strings 待过滤行为类型。 interval Integer 过滤时间。 最小值：1 最大值：7 表73 Rule 参数 参数类型 描述 table_name String 候选集表名。 rule_ratio Integer 规则占比。 最小值：1 最大值：100 priority Integer 优先级。 最小值：1 最大值：10 表74 AttrValueRules 参数 参数类型 描述 attr_values_a Array of AttrValue objects 被推荐对象的属性-值配置。 attr_values_b Array of AttrValue objects 待推荐对象的属性-值配置。 表75 AttrValue 参数 参数类型 描述 name String 属性名称。 value String 属性值。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型，取值为application/json。 X-Auth-Token 是 String 用户token，获取方式请参见获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 job_name 是 String 作业名称，1-64位的字母、数字、下划线、中划线组合。 最小长度：1 最大长度：64 description 否 String 描述。 category 是 String 类别: SERVICE，在线服务 job_type 是 String 作业类型： infer，推理服务 job_config 是 jobConfig object 作业配置。 topicUrn 否 String 通知消息配置。 表4 jobConfig 参数 是否必选 参数类型 描述 nearline_recall_param 否 NearLineRecallParam object 近线召回作业参数（近线召回作业需要提供此参数）。 max_recommended_num 否 Integer 最大候选集个数（所有召回作业需提供此参数）。 最小值：1 最大值：200 match_feature_pairs 否 Array of MatchFeaturePair objects 匹配特征对（属性匹配召回作业需要提供此参数）。 striping 否 Striping object 行条化策略（属性匹配召回作业、物品协同过滤召回作业、用户协同过滤召回作业需要提供此参数）。 match_type 否 String 匹配类型（属性匹配召回作业需提供此参数）： UI，基于用户推荐物品 UU，基于用户推荐用户 II，基于物品推荐物品 IU，基于物品推荐用户 matrix_factorization 否 MatrixFactorization object 矩阵分解参数配置（交替最小二乘协同过滤作业需提供此参数）。 behavior_frequencys 否 Array of BehaviorFrequency objects 行为频率信息（历史行为记忆召回作业、历史行为过滤作业需提供此参数）。 file_path 否 String 文件路径（人工配置候选集作业需要提供此参数）。 ucb_param 否 UcbParam object UCB作业参数（UCB召回作业需要提供此参数）。 behavior_gravity 否 BehaviorGravity object 重力衰减因子（综合行为热度召回作业需要提供此参数）。 category 否 Category object 类别（综合行为热度召回作业需要提供此参数）。 behavior_logic 否 String 行为逻辑过滤（历史行为过滤作业需提供此参数）： AND，同时满足则过滤 OR， 满足一个则过滤 features_engineering 否 EtlBasicParameter object 特征参数（离线特征工程作业需要提供此参数）。 sample_param 否 SampleParam object 样本参数（离线特征工程作业需要提供此参数）。 deep_learning_parameters 否 DeepLearingParam object 排序作业通用参数（LR、DEEPFM、AutoGroup需要提供此参数）。 algorithm_specify_parameters 否 AlgorithmSpecifyParameters object 排序算法特定参数（LR、DEEPFM、AutoGroup需要提供此参数）。 load_widetable 否 Boolean 导入宽表（离线数据导入作业需要提供此参数）。 load_profile 否 Boolean 导入画像（离线数据导入作业需要提供此参数）。 save_mode 否 String 保留已有宽表（离线数据导入作业需要提供此参数）： append，是 new，否 overwirte，覆盖 indicators 否 Array of Indicator objects 统计指标（效果评估作业需要提供此参数）。 offline_rank_job_name 否 String 离线排序作业名称（在线训练任务需要提供此参数）。 update_interval 否 Integer 更新周期（在线训练任务需要提供此参数）。 optimizer 否 Optimizer object 优化器（在线训练任务需要提供此参数）。 flows 否 Flow object 在线流程（在线训练任务需要提供此参数）。 表5 NearLineRecallParam 参数 是否必选 参数类型 描述 time_limit 否 Boolean 时间过滤。 timeFeature 否 String 时间特征。 retainDays 否 Integer 保留期(天)。 recall_fileds 否 Array of RecallFiled objects 召回字段。 itemCF_job_name 否 String 物品协同过滤作业名称。 表6 RecallFiled 参数 是否必选 参数类型 描述 name 否 String 字段名称。 value 否 Integer 使用字段值的个数。 最小值：1 最大值：10 缺省值：1 表7 MatchFeaturePair 参数 是否必选 参数类型 描述 user_feature_name 否 String 用户特征。 item_feature_name 否 String 物品特征。 weight 否 Double 权重。 match_count 否 Boolean 匹配个数度量。 表8 Striping 参数 是否必选 参数类型 描述 nearest_neighborhood 是 Integer 最近领域个数。 band 是 Integer 相似程度。 最小值：1 最大值：20 row 是 Integer 相似距离。 最小值：1 最大值：10 表9 MatrixFactorization 参数 是否必选 参数类型 描述 implicit_vector_rank 是 Integer 隐向量维度。 最小值：1 最大值：100 regular_param 是 Double 优化正则化系数。 最小值：1.0E-8 最大值：1 max_iterator_num 是 Integer 迭代次数。 最小值：1 最大值：50 表10 BehaviorFrequency 参数 是否必选 参数类型 描述 behavior_type 是 String 行为类型： view，曝光 click，点击 collect，收藏 uncollect，取消收藏 search_click，搜索后点击 comment，评论 share，分享 like，点赞 dislike，点衰 grade，评分 consume，消费 use，观看视频/听音乐/阅读 download，下载 tip，打赏 subscribe，关注 lower_limit 否 Integer 最小次数。 最小值：1 upper_limit 否 Integer 最大次数。 最小值：1 time_interval 是 Integer 时间区间。 最小值：1 表11 UcbParam 参数 是否必选 参数类型 描述 alpha 是 Double 折中参数。 最小值：0 最大值：1 min_used_num 是 Integer 最小行为次数。 最小值：30 最大值：1000 表12 BehaviorGravity 参数 是否必选 参数类型 描述 weaken_factor 否 Double 衰减因子。 最小值：0.1 最大值：5 view_type 否 String 行为次数统计方法： pv，访问量 uv，独立访客 algo_type 否 String 算法类型: normal，通用 time，时间 表13 Category 参数 是否必选 参数类型 描述 user_meta_list 否 Array of strings 用户特征。 item_meta_list 否 Array of strings 物品特征。 表14 EtlBasicParameter 参数 是否必选 参数类型 描述 user_features 否 Array of FeatureTransformation objects 用户特征。 item_features 否 Array of FeatureTransformation objects 物品特征。 rank_etl_filter 否 RankETLFilter object 过滤参数。 表15 FeatureTransformation 参数 是否必选 参数类型 描述 attr 否 Attribute object 特征。 discrete_method 否 String 离散方法： equal_distance_discrete，等距离散 user_define_discrete，自定义离散 normalize，归一化 null，不离散 params 否 Object 具体处理参数。 表16 Attribute 参数 是否必选 参数类型 描述 name 是 String 名称。 data_type 否 String 数据类型。 other_uses 否 Array of strings 其他用途。 表17 RankETLFilter 参数 是否必选 参数类型 描述 filter_type 是 String 行为去重方式： abs_weight，权重绝对值 date，日期 time_type 是 String 时间类型： day，天 week，周 month，月 is_monday_first 否 Boolean 周一是否是第一天。 表18 SampleParam 参数 是否必选 参数类型 描述 divide_type 是 String 训练集测试集划分方式： TIME，时间比例 RAMDOM，个数比例 train_rate 否 Double 训练数据占比。 最小值：0.01 最大值：1 test_rate 否 Double 测试数据占比。 最小值：0.01 最大值：1 表19 DeepLearingParam 参数 是否必选 参数类型 描述 initial_parameters 否 Initial object 初始化参数。 optimize_parameters 否 Optimizer object 优化参数。 regular_parameters 否 Regular object 正则化参数。 max_iterations 否 Integer 最大迭代轮数。 最小值：1 最大值：1000 early_stop_iterations 否 Integer 提前终止训练轮数。 最小值：1 最大值：1000 batch_size 否 Integer 批量大小。 最小值：1 dataset_split_parts 否 Integer 训练数据集切分数量。 最小值：1 最大值：10 restart_train 否 Boolean 重新训练。 表20 Initial 参数 是否必选 参数类型 描述 initial_method 是 String 初始化方法。 mean_value 否 Double 平均值。 最小值：-1 最大值：1 standard_deviation 否 Double 标准差。 最小值：0 最大值：1 min_value 否 Double 最小值。 最小值：-1 最大值：0 max_value 否 Double 最大值。 最小值：0 最大值：1 表21 Optimizer 参数 是否必选 参数类型 描述 type 否 String 优化器类型。 learning_rate 否 Double 学习率。 initial_accumulator_value 否 Double 初始梯度累加和。 最小值：0 最大值：1 lambda1 否 Double L1正则项系数。 最小值：0 最大值：1 lambda2 否 Double L2正则项系数。 最小值：0 最大值：1 epsilon 否 Double 数值稳定常量。 最小值：0 最大值：1 decay_rate 否 Double 衰减因子。 最小值：0 最大值：1 decay_steps 否 Double 衰减步长。 最小值：1 表22 Regular 参数 是否必选 参数类型 描述 l2_regularization 否 Double L2正则项系数。 最小值：0 最大值：1 regular_loss_compute_mode 否 String 正则损失计算方式。 embed_l2_regularization 否 Double 隐向量层L2正则化系数。 最小值：0 最大值：1 wide_l2_regularization 否 Double wide部分L2正则化系数。 最小值：0 最大值：1 structure_l2_regularization 否 Double 结构化部分L2正则化系数。 最小值：0 最大值：1 表23 AlgorithmSpecifyParameters 参数 是否必选 参数类型 描述 latent_vector_length 否 Integer 隐向量长度(DEEPFM需要提供此参数)。 最小值：1 最大值：100 architecture 否 Array of integers 神经网络结构(DEEPFM需要提供此参数)。 active_function 否 String 激活函数(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 value_keep_probability 否 Double 神经元值保留概率(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 最小值：0 最大值：1 embed_size 否 Array of integers 各阶隐向量长度(AutoGroup需要提供此参数)。 mlp_architecture 否 Array of integers 神经网络结构(AutoGroup需要提供此参数)。 max_order 否 Integer 最大交互阶数(AutoGroup需要提供此参数)。 hash_sizes 否 Array of integers 哈希长度(AutoGroup需要提供此参数)。 hash_compensation 否 Array of numbers 特征交互层惩罚项系数(AutoGroup需要提供此参数)。 use_wide_part 否 Boolean 使用线性部分(AutoGroup需要提供此参数)。 structure_optimizer 否 Optimizer object 优化器参数(AutoGroup需要提供此参数)。 merge_multi_hot 否 Boolean 融合多值特征(AutoGroup需要提供此参数)。 fix_structure 否 Boolean 固定哈希结构(AutoGroup需要提供此参数)。 表24 Indicator 参数 是否必选 参数类型 描述 indicator_name 否 String 指标名称： clickPVRate，点击PV率 clickUVRate，点击UV率 customize，自定义 indicator_params 否 IndicatorParam object 指标参数（自定义指标需要提供）。 表25 IndicatorParam 参数 是否必选 参数类型 描述 customize_parameter 否 CustomizeParameter object 自定义参数。 customize_formula 否 CustomizeFormula object 自定义公式。 表26 CustomizeParameter 参数 是否必选 参数类型 描述 alias 是 String 别名。 behavior_type 是 String 行为类型。 threshold 否 Double 阈值。 最小值：0 最大值：1 deduplication 是 String 去重。 表27 CustomizeFormula 参数 是否必选 参数类型 描述 alias 否 String 别名。 formula 否 String 公式。 表28 Flow 参数 是否必选 参数类型 描述 flow_id 是 String 流程id。 attr_pair_rules_filter 否 Array of AttrPairRules objects 属性对过滤。 attr_pair_rules_reserve 否 Array of AttrPairRules objects 属性对保留。 deduplication_list 否 Array of Deduplication objects 属性去重。 attribute_info 否 AttributeInfo object 综合排序信息。 bloom_filter_conf 否 BloomFilterConf object 布隆过滤器配置。 group_attr 否 String 分组打散属性。 pre_deal 否 Boolean 在排序前去重。 rank_setting 否 String 排序配置信息。 rules 否 Rule object 候选集融合。 filter_sets 否 Array of strings 过滤配置信息。 attr_value_rules_filter 否 Array of AttrValueRules objects 属性值过滤。 attr_value_rules_reserve 否 Array of AttrValueRules objects 属性值保留。 ctr_job 否 String 排序作业（使用点击率预估时需要提供此参数）。 ratio 否 Integer 流量占比。 最小值：1 最大值：100 toppings 否 Array of strings 需要置顶的候选集列表。 表29 AttrPairRules 参数 是否必选 参数类型 描述 attr_pairs 否 Array of AttrPair objects 属性对。 表30 AttrPair 参数 是否必选 参数类型 描述 party_a 否 String 被推荐对象的属性名。 party_b 否 String 被推荐对象的属性名。 表31 Deduplication 参数 是否必选 参数类型 描述 attributes 否 Array of strings 属性。 表32 AttributeInfo 参数 是否必选 参数类型 描述 rank_feature_pairs 否 Array of RankFeaturePair objects 属性匹配对。 numerical_attrs 否 Array of NumericalAttr objects 属性权重。 num_statistics_type 否 String 统计方式： ORDER，顺序 ABS，绝对值 表33 RankFeaturePair 参数 是否必选 参数类型 描述 feature_name_a 否 String 待推荐对象的属性。 feature_name_b 否 String 被推荐对象的属性。 weight 否 Float 权重。 最小值：0.01 最大值：1 表34 NumericalAttr 参数 是否必选 参数类型 描述 name 是 String 特征名。 weight 是 Float 权重。 最小值：0.001 最大值：1 表35 BloomFilterConf 参数 是否必选 参数类型 描述 behaviors 否 Array of strings 待过滤行为类型。 interval 否 Integer 过滤时间。 最小值：1 最大值：7 表36 Rule 参数 是否必选 参数类型 描述 table_name 是 String 候选集表名。 rule_ratio 是 Integer 规则占比。 最小值：1 最大值：100 priority 是 Integer 优先级。 最小值：1 最大值：10 表37 AttrValueRules 参数 是否必选 参数类型 描述 attr_values_a 否 Array of AttrValue objects 被推荐对象的属性-值配置。 attr_values_b 是 Array of AttrValue objects 待推荐对象的属性-值配置。 表38 AttrValue 参数 是否必选 参数类型 描述 name 是 String 属性名称。 value 是 String 属性值。

URI POST /v2.0/{project_id}/workspaces/{workspace_id}/resources/{resource_id}/service-instance 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方式请参见获取项目ID。 resource_id 是 String 资源id（数据源id或场景id）。 workspace_id 是 String 工作空间id。

请求示例 调度指定的作业 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/jobs/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/schedule-job?action=START-

URI POST /v2.0/{project_id}/workspaces/{workspace_id}/resources/{resource_id}/jobs/{job_id}/schedule-job 表1 路径参数 参数 是否必选 参数类型 描述 job_id 是 String 作业id。 project_id 是 String 项目id，获取方式请参见获取项目ID。 resource_id 是 String 资源id，可以为数据源id或场景id。 workspace_id 是 String 工作空间id。 表2 Query参数 参数 是否必选 参数类型 描述 action 否 String 动作类型： START，启动 STOP，停止

概述 欢迎使用推荐系统（Recommender System，简称RES） 。基于华为大数据和人工智能技术，提供推荐平台和算法服务，并帮助企业构建个性化推荐应用，助力提升网站/APP的点击率、留存率和用户体验。 您可以使用本文档提供推荐系统服务API的描述、语法、参数说明及样例等内容，进行相关操作，例如推荐系统的具体接口使用说明。支持的全部操作请参见API概览。 在调用推荐系统API之前，请确保已经充分了解推荐系统相关概念，详细信息请参见产品介绍。 父主题： 使用前必读

响应示例 状态码： 200 OK { "jobs" : [ { "workspace_id" : "a79b01afa69d4ddc943aa3423fc43531", "resource_id" : "c27aea2b50004187a36fdbd136368895", "job_id" : "0516d537a82c460caf2b78ebd638eb3b", "job_name" : "ab", "description" : "", "platform" : "OFFLINE", "category" : "RECALL", "job_type" : "ItemCf", "status" : "FAILED", "job_config" : { "striping" : { "nearest_neighborhood" : 100.0, "band" : 4.0, "row" : 5.0 }, "max_recommended_num" : 100.0, "schedule" : "00 50 01 * * ?" }, "enable" : 0, "smnEnable" : 0 }, { "workspace_id" : "a79b01afa69d4ddc943aa3423fc43531", "resource_id" : "c27aea2b50004187a36fdbd136368895", "job_id" : "2bb9cce018364e9992537d0776009222", "job_name" : "r2", "description" : "00", "platform" : "OFFLINE", "category" : "RECALL", "job_type" : "AttributeMatch", "status" : "CANCELED", "job_config" : { "striping" : { "nearest_neighborhood" : 20.0, "band" : 4.0, "row" : 5.0 }, "max_recommended_num" : 100.0, "schedule" : "00 50 01 * * ?", "match_type" : "User-Item", "match_feature_pairs" : [ { "user_feature_name" : "age", "item_feature_name" : "category", "alias" : "a", "weight" : 1.0 } ] }, "enable" : 1, "smnEnable" : 0 }, { "workspace_id" : "a79b01afa69d4ddc943aa3423fc43531", "resource_id" : "c27aea2b50004187a36fdbd136368895", "job_id" : "929d25d76a6f45b3a06490074949484b", "job_name" : "r4", "description" : "", "platform" : "OFFLINE", "category" : "RECALL", "job_type" : "ItemCf", "status" : "FAILED", "job_config" : { "striping" : { "nearest_neighborhood" : 100.0, "band" : 4.0, "row" : 5.0 }, "max_recommended_num" : 100.0, "schedule" : "00 50 01 * * ?" }, "enable" : 1, "smnEnable" : 0 }, { "workspace_id" : "a79b01afa69d4ddc943aa3423fc43531", "resource_id" : "c27aea2b50004187a36fdbd136368895", "job_id" : "ca3fa69dbbaa4dcea3a0f5d466af0742", "job_name" : "a", "description" : "", "platform" : "OFFLINE", "category" : "RECALL", "job_type" : "ItemCf", "status" : "FAILED", "job_config" : { "striping" : { "nearest_neighborhood" : 100.0, "band" : 4.0, "row" : 5.0 }, "max_recommended_num" : 100.0, "schedule" : "00 50 01 * * ?" }, "enable" : 1, "smnEnable" : 0 }, { "workspace_id" : "a79b01afa69d4ddc943aa3423fc43531", "resource_id" : "c27aea2b50004187a36fdbd136368895", "job_id" : "f79e55ca4e314d4188fab3045554efa8", "job_name" : "r3", "description" : "", "platform" : "OFFLINE", "category" : "RECALL", "job_type" : "BhvHistory", "status" : "RUNNING", "job_config" : { "behavior_frequencys" : [ { "time_interval" : 30.0, "behavior_type" : "view", "lower_limit" : 1.0, "upper_limit" : 1.0 } ], "max_recommended_num" : 100.0, "schedule" : "00 50 01 * * ?" }, "enable" : 1, "smnEnable" : 0 } ], "is_success" : true}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 is_success Boolean 是否成功 jobs Array of jobs objects 作业详情 message String 返回消息（请求成功时，不返回此字段） error_code String 错误码（请求成功时，不返回此字段） 表5 jobs 参数 参数类型 描述 category String 类别。 config_info String 配置信息。 description String 描述。 job_id String 作业id。 job_name String 作业名称。 job_type String 作业类型。 next_schedule_time Integer 下次调度时间。 platform String 平台。 resource_id String 资源id。 schedule String 调度参数。 status String 状态。 workspace_id String 工作空间id。 job_config jobConfig object 作业配置。 表6 jobConfig 参数 参数类型 描述 nearline_recall_param NearLineRecallParam object 近线召回作业参数（近线召回作业需要提供此参数）。 max_recommended_num Integer 最大候选集个数（所有召回作业需提供此参数）。 最小值：1 最大值：200 match_feature_pairs Array of MatchFeaturePair objects 匹配特征对（属性匹配召回作业需要提供此参数）。 striping Striping object 行条化策略（属性匹配召回作业、物品协同过滤召回作业、用户协同过滤召回作业需要提供此参数）。 match_type String 匹配类型（属性匹配召回作业需提供此参数）： UI，基于用户推荐物品 UU，基于用户推荐用户 II，基于物品推荐物品 IU，基于物品推荐用户 matrix_factorization MatrixFactorization object 矩阵分解参数配置（交替最小二乘协同过滤作业需提供此参数）。 behavior_frequencys Array of BehaviorFrequency objects 行为频率信息（历史行为记忆召回作业、历史行为过滤作业需提供此参数）。 file_path String 文件路径（人工配置候选集作业需要提供此参数）。 ucb_param UcbParam object UCB作业参数（UCB召回作业需要提供此参数）。 behavior_gravity BehaviorGravity object 重力衰减因子（综合行为热度召回作业需要提供此参数）。 category Category object 类别（综合行为热度召回作业需要提供此参数）。 behavior_logic String 行为逻辑过滤（历史行为过滤作业需提供此参数）： AND，同时满足则过滤 OR， 满足一个则过滤 features_engineering EtlBasicParameter object 特征参数（离线特征工程作业需要提供此参数）。 sample_param SampleParam object 样本参数（离线特征工程作业需要提供此参数）。 deep_learning_parameters DeepLearingParam object 排序作业通用参数（LR、DEEPFM、AutoGroup需要提供此参数）。 algorithm_specify_parameters AlgorithmSpecifyParameters object 排序算法特定参数（LR、DEEPFM、AutoGroup需要提供此参数）。 load_widetable Boolean 导入宽表（离线数据导入作业需要提供此参数）。 load_profile Boolean 导入画像（离线数据导入作业需要提供此参数）。 save_mode String 保留已有宽表（离线数据导入作业需要提供此参数）： append，是 new，否 overwirte，覆盖 indicators Array of Indicator objects 统计指标（效果评估作业需要提供此参数）。 offline_rank_job_name String 离线排序作业名称（在线训练任务需要提供此参数）。 update_interval Integer 更新周期（在线训练任务需要提供此参数）。 optimizer Optimizer object 优化器（在线训练任务需要提供此参数）。 flows Flow object 在线流程（在线训练任务需要提供此参数）。 表7 NearLineRecallParam 参数 参数类型 描述 time_limit Boolean 时间过滤。 timeFeature String 时间特征。 retainDays Integer 保留期(天)。 recall_fileds Array of RecallFiled objects 召回字段。 itemCF_job_name String 物品协同过滤作业名称。 表8 RecallFiled 参数 参数类型 描述 name String 字段名称。 value Integer 使用字段值的个数。 最小值：1 最大值：10 缺省值：1 表9 MatchFeaturePair 参数 参数类型 描述 user_feature_name String 用户特征。 item_feature_name String 物品特征。 weight Double 权重。 match_count Boolean 匹配个数度量。 表10 Striping 参数 参数类型 描述 nearest_neighborhood Integer 最近领域个数。 band Integer 相似程度。 最小值：1 最大值：20 row Integer 相似距离。 最小值：1 最大值：10 表11 MatrixFactorization 参数 参数类型 描述 implicit_vector_rank Integer 隐向量维度。 最小值：1 最大值：100 regular_param Double 优化正则化系数。 最小值：1.0E-8 最大值：1 max_iterator_num Integer 迭代次数。 最小值：1 最大值：50 表12 BehaviorFrequency 参数 参数类型 描述 behavior_type String 行为类型： view，曝光 click，点击 collect，收藏 uncollect，取消收藏 search_click，搜索后点击 comment，评论 share，分享 like，点赞 dislike，点衰 grade，评分 consume，消费 use，观看视频/听音乐/阅读 download，下载 tip，打赏 subscribe，关注 lower_limit Integer 最小次数。 最小值：1 upper_limit Integer 最大次数。 最小值：1 time_interval Integer 时间区间。 最小值：1 表13 UcbParam 参数 参数类型 描述 alpha Double 折中参数。 最小值：0 最大值：1 min_used_num Integer 最小行为次数。 最小值：30 最大值：1000 表14 BehaviorGravity 参数 参数类型 描述 weaken_factor Double 衰减因子。 最小值：0.1 最大值：5 view_type String 行为次数统计方法： pv，访问量 uv，独立访客 algo_type String 算法类型: normal，通用 time，时间 表15 Category 参数 参数类型 描述 user_meta_list Array of strings 用户特征。 item_meta_list Array of strings 物品特征。 表16 EtlBasicParameter 参数 参数类型 描述 user_features Array of FeatureTransformation objects 用户特征。 item_features Array of FeatureTransformation objects 物品特征。 rank_etl_filter RankETLFilter object 过滤参数。 表17 FeatureTransformation 参数 参数类型 描述 attr Attribute object 特征。 discrete_method String 离散方法： equal_distance_discrete，等距离散 user_define_discrete，自定义离散 normalize，归一化 null，不离散 params Object 具体处理参数。 表18 Attribute 参数 参数类型 描述 name String 名称。 data_type String 数据类型。 other_uses Array of strings 其他用途。 表19 RankETLFilter 参数 参数类型 描述 filter_type String 行为去重方式： abs_weight，权重绝对值 date，日期 time_type String 时间类型： day，天 week，周 month，月 is_monday_first Boolean 周一是否是第一天。 表20 SampleParam 参数 参数类型 描述 divide_type String 训练集测试集划分方式： TIME，时间比例 RAMDOM，个数比例 train_rate Double 训练数据占比。 最小值：0.01 最大值：1 test_rate Double 测试数据占比。 最小值：0.01 最大值：1 表21 DeepLearingParam 参数 参数类型 描述 initial_parameters Initial object 初始化参数。 optimize_parameters Optimizer object 优化参数。 regular_parameters Regular object 正则化参数。 max_iterations Integer 最大迭代轮数。 最小值：1 最大值：1000 early_stop_iterations Integer 提前终止训练轮数。 最小值：1 最大值：1000 batch_size Integer 批量大小。 最小值：1 dataset_split_parts Integer 训练数据集切分数量。 最小值：1 最大值：10 restart_train Boolean 重新训练。 表22 Initial 参数 参数类型 描述 initial_method String 初始化方法。 mean_value Double 平均值。 最小值：-1 最大值：1 standard_deviation Double 标准差。 最小值：0 最大值：1 min_value Double 最小值。 最小值：-1 最大值：0 max_value Double 最大值。 最小值：0 最大值：1 表23 Optimizer 参数 参数类型 描述 type String 优化器类型。 learning_rate Double 学习率。 initial_accumulator_value Double 初始梯度累加和。 最小值：0 最大值：1 lambda1 Double L1正则项系数。 最小值：0 最大值：1 lambda2 Double L2正则项系数。 最小值：0 最大值：1 epsilon Double 数值稳定常量。 最小值：0 最大值：1 decay_rate Double 衰减因子。 最小值：0 最大值：1 decay_steps Double 衰减步长。 最小值：1 表24 Regular 参数 参数类型 描述 l2_regularization Double L2正则项系数。 最小值：0 最大值：1 regular_loss_compute_mode String 正则损失计算方式。 embed_l2_regularization Double 隐向量层L2正则化系数。 最小值：0 最大值：1 wide_l2_regularization Double wide部分L2正则化系数。 最小值：0 最大值：1 structure_l2_regularization Double 结构化部分L2正则化系数。 最小值：0 最大值：1 表25 AlgorithmSpecifyParameters 参数 参数类型 描述 latent_vector_length Integer 隐向量长度(DEEPFM需要提供此参数)。 最小值：1 最大值：100 architecture Array of integers 神经网络结构(DEEPFM需要提供此参数)。 active_function String 激活函数(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 value_keep_probability Double 神经元值保留概率(DEEPFM需要提供此参数,AutoGroup需要提供此参数)。 最小值：0 最大值：1 embed_size Array of integers 各阶隐向量长度(AutoGroup需要提供此参数)。 mlp_architecture Array of integers 神经网络结构(AutoGroup需要提供此参数)。 max_order Integer 最大交互阶数(AutoGroup需要提供此参数)。 hash_sizes Array of integers 哈希长度(AutoGroup需要提供此参数)。 hash_compensation Array of numbers 特征交互层惩罚项系数(AutoGroup需要提供此参数)。 use_wide_part Boolean 使用线性部分(AutoGroup需要提供此参数)。 structure_optimizer Optimizer object 优化器参数(AutoGroup需要提供此参数)。 merge_multi_hot Boolean 融合多值特征(AutoGroup需要提供此参数)。 fix_structure Boolean 固定哈希结构(AutoGroup需要提供此参数)。 表26 Indicator 参数 参数类型 描述 indicator_name String 指标名称： clickPVRate，点击PV率 clickUVRate，点击UV率 customize，自定义 indicator_params IndicatorParam object 指标参数（自定义指标需要提供）。 表27 IndicatorParam 参数 参数类型 描述 customize_parameter CustomizeParameter object 自定义参数。 customize_formula CustomizeFormula object 自定义公式。 表28 CustomizeParameter 参数 参数类型 描述 alias String 别名。 behavior_type String 行为类型。 threshold Double 阈值。 最小值：0 最大值：1 deduplication String 去重。 表29 CustomizeFormula 参数 参数类型 描述 alias String 别名。 formula String 公式。 表30 Flow 参数 参数类型 描述 flow_id String 流程id。 attr_pair_rules_filter Array of AttrPairRules objects 属性对过滤。 attr_pair_rules_reserve Array of AttrPairRules objects 属性对保留。 deduplication_list Array of Deduplication objects 属性去重。 attribute_info AttributeInfo object 综合排序信息。 bloom_filter_conf BloomFilterConf object 布隆过滤器配置。 group_attr String 分组打散属性。 pre_deal Boolean 在排序前去重。 rank_setting String 排序配置信息。 rules Rule object 候选集融合。 filter_sets Array of strings 过滤配置信息。 attr_value_rules_filter Array of AttrValueRules objects 属性值过滤。 attr_value_rules_reserve Array of AttrValueRules objects 属性值保留。 ctr_job String 排序作业（使用点击率预估时需要提供此参数）。 ratio Integer 流量占比。 最小值：1 最大值：100 toppings Array of strings 需要置顶的候选集列表。 表31 AttrPairRules 参数 参数类型 描述 attr_pairs Array of AttrPair objects 属性对。 表32 AttrPair 参数 参数类型 描述 party_a String 被推荐对象的属性名。 party_b String 被推荐对象的属性名。 表33 Deduplication 参数 参数类型 描述 attributes Array of strings 属性。 表34 AttributeInfo 参数 参数类型 描述 rank_feature_pairs Array of RankFeaturePair objects 属性匹配对。 numerical_attrs Array of NumericalAttr objects 属性权重。 num_statistics_type String 统计方式： ORDER，顺序 ABS，绝对值 表35 RankFeaturePair 参数 参数类型 描述 feature_name_a String 待推荐对象的属性。 feature_name_b String 被推荐对象的属性。 weight Float 权重。 最小值：0.01 最大值：1 表36 NumericalAttr 参数 参数类型 描述 name String 特征名。 weight Float 权重。 最小值：0.001 最大值：1 表37 BloomFilterConf 参数 参数类型 描述 behaviors Array of strings 待过滤行为类型。 interval Integer 过滤时间。 最小值：1 最大值：7 表38 Rule 参数 参数类型 描述 table_name String 候选集表名。 rule_ratio Integer 规则占比。 最小值：1 最大值：100 priority Integer 优先级。 最小值：1 最大值：10 表39 AttrValueRules 参数 参数类型 描述 attr_values_a Array of AttrValue objects 被推荐对象的属性-值配置。 attr_values_b Array of AttrValue objects 待推荐对象的属性-值配置。 表40 AttrValue 参数 参数类型 描述 name String 属性名称。 value String 属性值。

URI GET /v2.0/{project_id}/workspaces/{workspace_id}/resources/{resource_id}/job-instance 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方式请参见获取项目ID resource_id 是 String 资源id（数据源id 或 场景id） workspace_id 是 String 工作空间id 表2 Query参数 参数 是否必选 参数类型 描述 category 是 String 类别： RECALL，召回作业 DATASOURCE，数据源作业 FILTER，过滤作业 SORTING，排序作业 EVALUATE，效果评估作业

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result_set Array of result_set objects 候选集列表 is_success Boolean 是否成功 message String 返回消息（请求成功时，不返回此字段） error_code String 错误码（请求成功时，不返回此字段） 表5 result_set 参数 参数类型 描述 availability Integer 可用性 category String 类别 job_id String 作业编号 job_type String 作业类型 rec_id String rec编号 rec_type String rec类型 scene_id String 场景编号 table_name String 表名 workspace_id String 工作空间编号

响应示例 状态码： 200 OK { "result_set" : [ { "rec_id" : "22ab62118c404a668232ba43fb8b762c", "workspace_id" : "a79b01afa69d4ddc943aa3423fc43531", "scene_id" : "c27aea2b50004187a36fdbd136368895", "job_id" : "929d25d76a6f45b3a06490074949484b", "table_name" : "r4-UIREC", "rec_type" : "UIREC", "availability" : 1, "category" : "RECALL", "job_type" : "ItemCf" }, { "rec_id" : "382af563b5bf454c9242b9989f95d120", "workspace_id" : "a79b01afa69d4ddc943aa3423fc43531", "scene_id" : "c27aea2b50004187a36fdbd136368895", "job_id" : "2bb9cce018364e9992537d0776009222", "table_name" : "r2-UIREC", "rec_type" : "UIREC", "availability" : 1, "category" : "RECALL", "job_type" : "AttributeMatch" }, { "rec_id" : "d01e9e29aa64473da12a04f6b4e3a3f1", "workspace_id" : "a79b01afa69d4ddc943aa3423fc43531", "scene_id" : "c27aea2b50004187a36fdbd136368895", "job_id" : "0516d537a82c460caf2b78ebd638eb3b", "table_name" : "ab-UIREC", "rec_type" : "UIREC", "availability" : 1, "category" : "RECALL", "job_type" : "ItemCf" }, { "rec_id" : "d05955af59bf4b09b2539308434ebd97", "workspace_id" : "a79b01afa69d4ddc943aa3423fc43531", "scene_id" : "c27aea2b50004187a36fdbd136368895", "job_id" : "f79e55ca4e314d4188fab3045554efa8", "table_name" : "r3-UIREC", "rec_type" : "UIREC", "availability" : 1, "category" : "RECALL", "job_type" : "BhvHistory" }, { "rec_id" : "d9a317a2f1bb46fc8a25096a310108d6", "workspace_id" : "a79b01afa69d4ddc943aa3423fc43531", "scene_id" : "c27aea2b50004187a36fdbd136368895", "job_id" : "ca3fa69dbbaa4dcea3a0f5d466af0742", "table_name" : "a-UIREC", "rec_type" : "UIREC", "availability" : 1, "category" : "RECALL", "job_type" : "ItemCf" } ], "is_success" : true}

URI GET /v2.0/{project_id}/workspaces/{workspace_id}/resources/{resource_id}/result-set 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方式请参见获取项目ID resource_id 是 String 资源id workspace_id 是 String 工作空间id 表2 Query参数 参数 是否必选 参数类型 描述 use_type 是 String 使用类型： UI，基于用户推荐物品 UU，基于用户推荐用户 II，基于物品推荐物品 IU，基于物品推荐用户

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 offline_spec Array of strings 离线计算规格。 nearline_spec Array of strings 实时计算规格。 deep_learning_spec Array of strings 排序模型计算规格。 is_success Boolean 请求是否成功。 message String 返回消息（请求成功时，不返回此字段）。 error_code String 错误码（请求成功时，不返回此字段）。

URI POST /v2.0/{project_id}/workspaces/{workspace_id}/resources/{resource_id}/schedule-scene 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方式请参见获取项目ID。 resource_id 是 String 资源id，可以为数据源id或场景id。 workspace_id 是 String 工作空间id。 表2 Query参数 参数 是否必选 参数类型 描述 action 否 String 动作类型： START，启动 STOP，停止

API概览 类型 API 说明 工作空间 查询企业项目列表 查询用户在当前项目id下的企业项目列表。 创建工作空间 用于在推荐系统下面创建独立的工作空间，用于资源的隔离 查询工作空间列表 用于查询当前用户具有操作权限的工作空间列表。 查询工作空间详情 查询指定工作空间的具体信息。 更新工作空间 更新工作空间信息, 只允许更新描述信息。 删除工作空间 删除指定工作空间。 查询规格 查询训练规格 查询当前推荐系统所提供的离线计算规格，实时计算规格和排序模型训练规格。在创建数据源和场景时，需要提供此信息。 数据源 创建数据源 在指定的工作空间下面创建一个新的数据源。 查询数据源列表 查询当前工作空间下的数据源列表。 查询数据源详情 查询指定数据源的详情信息。 修改数据源内容 修改指定数据源的配置内容。 修改数据源特征 修改数据源中的特征。 删除数据源 删除数据源。 查询数据源任务结果 查询指定数据源下离线任务的结果。其中包括数据格式，数据检测、数据探索及效果评估的内容。 场景 创建自定义场景 在指定工作空间下面创建自定义场景。 创建智能场景 在指定工作空间下面创建智能场景。 查询场景详情 查询指定场景的详情。 查询场景列表 查询当前工作空间下的场景列表。 更新自定义场景内容 更新自定义场景的内容信息。 更新智能场景内容 更新智能场景的内容信息。 删除场景 该接口用于删除场景，删除之后不能恢复，请您谨慎操作。 训练作业 新建训练作业 新建训练作业元数据，新建成功之后可手动执行此任务。 新建多个训练作业 批量新建作业。 查询训练作业 查询resource_id（数据源id或场景id）下的指定类型的作业。 修改训练作业参数 修改指定作业的元数据信息。 修改训练作业状态 修改作业状态(启用，禁用)。 查询训练作业候选集 查询给定workspaces_id和指定resource_id下的候选集。 删除训练作业 删除训练作业信息。 在线服务 新建在线服务 新建在线服务元数据，新建成功之后可手动发布此服务。 查询在线服务详情 根据给定的workspace_id和resource_id及category查询在线服务。 修改在线服务参数 修改指定在线服务的元数据内容。 删除在线服务 删除在线服务实例。 调度 执行作业 执行独立的作业。 执行场景 执行场景下面的所有作业和服务。

示例 成功响应示例 { "is_success": true, "quotas": { "resources": [ { "type": "infer_service", "quota": "9", "unit": "个", "min": 1, "max": 100, "used": 9 } ] }} 失败响应示例 { "is_success": false, "error_code": "res.8004", "error_msg": "Default quota(infer_service) is null."}

调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”，其中{Endpoint}为 IAM 的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中“projects”下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。例如RES服务在“华北-北京四”区域的Endpoint为“res.cn-north-4.myhuaweicloud.com”。 resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxx为project的名称，如“cn-north-4”，获取方法请参见获取用户名、账号名和项目name。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参加AK/SK认证。 X-Project-ID：子项目ID，可选，在多项目场景中使用。 X-Domain-ID：账号ID。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-4", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "res.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内，12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中“auth.scope”的取值需要选择“project”，如下所示。 {"auth": {"identity": {"methods": ["password"],"password": {"user": {"name": "username","password": "********","domain": {"name": "domainname"}}}},"scope": {"project": {"name": "xxxxxxxx"}}}} 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-4.myhuaweicloud.com/v3/auth/projectsContent-Type: application/jsonX-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。

请求示例 更新近线召回作业 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/job-instance/testuuidxxxxxxxxxxxxxxxxxxxxxxxx{ "job_name" : "NearlineRecall-test", "description" : "nearlinerecall", "category" : "RECALL", "job_type" : "NearlineRecall", "job_config" : { "nearline_recall_param" : { "time_limit" : true, "time_feature" : "publishTime", "retain_days" : 2, "recall_fileds" : [ { "name" : "author", "value" : 1 }, { "name" : "category", "value" : 1 }, { "name" : "tags", "value" : 3 } ], "max_recommended_num" : 100 } }}