华为云用户手册

请求消息 请求参请参见表2。 表2 请求参数说明 参数名称 是否必选 参数类型 说明 workspace_id 否 String 默认为0 job_name 是 String 训练作业名称，最大长度为20字符。 job_description 否 String 训练作业描述，最大长度为256字符。 algorithm_type 是 String 算法类型 UPDATE_INDEX_SCHEMA algorithm_parameters 是 JSON 算法参数。 UPDATE_INDEX_SCHEMA，请参见表6。 storage 是 JSON 请参见表5，存储平台。 offline_platform 是 JSON 请参见表3，离线计算平台信息。 表3 offline_platform参数说明 参数名称 是否必选 参数类型 说明 platform 是 String 平台名称，最大长度64，支持 DLI 。 platform_parameter 是 JSON 请参见表4，平台参数。 computing_resource 否 String 指定DLI运行任务的资源规格。 config_load_path 是 String 读取配置源路径。 表4 platform_parameter参数说明 参数名称 是否必选 参数类型 说明 cluster_name 是 String 集群名称。 cluster_id 否 String 集群ID。 表5 storage参数说明 参数名称 是否必选 参数类型 说明 user_profiles_table 否 JSON 用户属性存储表.请参见表8， algorithm_type为INITIAL_PROFILES_GENERATION时必选。 item_profiles_table 否 JSON 物品属性存储表请参见表8， algorithm_type为INITIAL_PROFILES_GENERATION时必选。 表6 algorithm_parameters参数说明 参数名称 是否必选 参数类型 说明 作业ID(job_id) 是 String 作业的ID。离线策略特征工程-初始用户画像-物品画像-标准宽表算子、近线策略基于用户数据更新用户画像算子、近线策略基于物品数据更新物品画像算子可以作为此处的作业ID。 新的全局特征配置文件路径(new_global_features_info) 是 String 该文件为JSON格式，包含特征名、特征大类、特征值类型。 新的全局特征配置文件（new_global_features_info）包含的特征是在原作业ID（job_id）对应的全局特征配置文件的特征基础上新增的一些特征或者删除一些特征；两份文件重复的特征名对应的特征类型必须保持一致。

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

请求消息 请求参数请参见表2。 表2 请求参数说明 参数名称 是否必选 参数类型 描述信息 workspace_id 否 String 工作空间ID，默认为0。 job_name 是 String 训练作业名称，最大长度为20字符。 job_description 否 String 训练作业描述，最大长度为256字符。 nearline_platform 是 JSON 请参见表3，近线计算平台。 strategy 是 JSON 请参见表5，策略信息。 表3 nearline_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 strategy 参数说明 参数名称 是否必选 参数类型 说明 strategy_type 是 String 可选值：nearline。 name 是 String 策略别名，最大长度60字符。 algorithm_type 是 String 算法类型。现仅提供一种字段。 NEARLINE_ONLINE_TRAINING parameter 是 JSON 请参见表6，算法参数。 表6 parameter 参数说明 参数名称 是否必选 参数类型 说明 data_source 是 JSON 请参见表7，数据源参数。 实时流近线任务支持的推荐标准数据为用户操作行为表。 data_source_config 是 JSON 请参见表10，数据源参数配置。 algorithm_config 是 JSON 请参见表11，算法参数配置。 表7 data_source 参数说明 参数名称 是否必选 参数类型 说明 platform 是 String 平台名称，现在只支持DIS。将实时近线任务需要的数据添加到DIS中，推荐系统通过读取该数据进行近线计算。 in_stream_conf 是 JSON 请参见表8，平台参数。 out_stream_conf 是 JSON 请参见表9，平台参数。 表8 in_stream_conf 参数说明 参数名称 是否必选 参数类型 说明 stream_name 否 String 输入流DIS通道名称。该通道用于接收近线行为数据。 starting_offsets 是 String 读取DIS数据的起始位置。 LATEST：从最新的数据开始读取。 EARLIEST：从最旧的数据开始读取。 表9 out_stream_conf 参数说明 参数名称 是否必选 参数类型 说明 stream_name 否 String 输出流DIS通道名称。该通道用于存放由行为数据和画像库计算生成的排序预处理数据，以供模型训练。通道中的数据属于流式训练作业产生的中间数据，使用者只需指定通道名称，无需往该通道发送或获取数据。 starting_offsets 是 String 读取DIS数据的起始位置，LATEST表示从最新的数据开始读取。 表10 data_source_config 参数说明 参数名称 是否必选 参数类型 说明 interval 是 Integer 近线策略流处理的窗口时间，单位为秒，10代表每隔10s进行一次。包括数据读取和处理的流计算。 表11 algorithm_config 参数说明 参数名称 是否必选 参数类型 说明 online_job_uuid 是 String 关联的在线服务的uuid。 flow_name 是 String 关联在线服务的其中一个在线流程的名称。流式训练作业所需的行为参数、模型文件路径、数据预处理信息等参数会从指定的在线服务的在线流程中获取。 online_training_config 是 JSON 请参见表12，平台参数。 bad_record_log 否 String 异常数据记录日志路径。路径填写到文件夹。 表12 online_training_config 参数说明 参数名称 是否必选 参数类型 说明 spec_id 是 Integer 训练作业选择的资源规格ID。在使用ModelArts之前需要查询ModelArts服务AK/SK并确保关联AK/SK到ModelArts服务，然后通过查询ModelArts计算节点规格获取spec_id返回的值。 optimize_parameters 是 JSON 请参见表13，平台参数。 update_interval 是 Integer 排序模型的更新时间间隔，单位为分钟，例如10代表每隔10分钟保存一次排序模型到OBS，以供在线服务使用。 表13 optimize_parameters 参数说明 参数名称 是否必选 参数类型 说明 type 是 String 优化器类型。现仅提供一种字段。 ftrl：指定为使用ftrl优化器。 initial_accumulator_value 是 Double 用来动态调整学习步长。取值范围(0,1]，默认值为0.1。 lambda1 是 Double 叠加在模型的1范数之上，用来对模型值进行限制防止过拟合。取值范围[0,1]，默认值为0。 lambda2 是 Double 叠加在模型的2范数之上，用来对模型值进行限制防止过拟合。取值范围[0,1]，默认值为0。 learning_rate 是 Double 决定优化器在优化方向上前进步长的参数。取值范围(0,1]，默认值为0.1。

请求示例 创建场景 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/scenes{ "scene_name" : "jby-test-0227-4", "category" : "customize", "type" : "UI", "service_type" : "rank", "datasource_id" : "6a3475a7dd11492e8d14f73a3719333b", "ds_config" : { "time_interval" : 30 }, "specs_config" : { "offline" : "4CU", "nearline" : "2CU", "rank" : "8CU", "online_tps" : 10 }}

响应示例 状态码： 200 OK { "scene" : { "type" : "UI", "service_type" : "rank", "scene_name" : "jby-test-0227-4", "category" : "customize", "scene_id" : "f715e1c61f1f40489b2e4594650fffd8", "datasource_id" : "6a3475a7dd11492e8d14f73a3719333b", "status" : "INITIALIZED", "created_at" : 1584628346333, "update_at" : 0, "workspace_id" : "68887f2a855f45e7ab4850ecc7ca28c2" }, "is_success" : true}

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 is_success Boolean 是否成功。 message String 返回消息（请求成功时，不返回此字段）。 scene scene object 场景信息。 error_code String 错误码（请求成功时，不返回此字段）。 表8 scene 参数 参数类型 描述 category String 类型。 type String 场景类型。 scene_name String 场景名称。 scene_id String 场景id。 datasource_id String 数据源id。 status String 状态。 created_at Integer 创建时间。 update_at Integer 更新时间。 workspace_id String 工作空间id。 service_type String 服务类型。

URI POST /v2.0/{project_id}/workspaces/{workspace_id}/scenes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方式请参见获取项目ID。 workspace_id 是 String 工作空间id。 表2 Query参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token，获取方式请参见获取用户Token。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型，取值为application/json。 表4 请求Body参数 参数 是否必选 参数类型 描述 category 是 String 场景类型： customize，自定义推荐 datasource_id 是 String 数据源id。 ds_config 是 ds_config object 数据源配置。 scene_name 是 String 场景名称，1-64位的字母、数字、下划线、中划线组合。 最小长度：1 最大长度：64 specs_config 是 SpecsConfig object 计算规格。 type 是 String 场景类型： UI，基于用户推荐物品 UU，基于用户推荐用户 II，基于物品推荐物品 IU，基于物品推荐用户 service_type 是 String 服务类型： rank，排序服务 rec，推荐服务 表5 ds_config 参数 是否必选 参数类型 描述 time_interval 否 Integer 数据选择(天)。 category_type 否 String 物品类别。 表6 SpecsConfig 参数 是否必选 参数类型 描述 offline 是 String 离线计算规格。 nearline 否 String 实时计算规格。 rank 否 String 深度学习计算规格。 online_tps 否 Integer 在线服务最大并发数。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 is_success Boolean 是否成功。 scene res_scene object 场景详情。 message String 返回消息（请求成功时，不返回此字段）。 error_code String 错误码（请求成功时，不返回此字段）。 表4 res_scene 参数 参数类型 描述 category String 类型。 datasource_id String 数据源id。 ds_config DataConfig object 数据源配置。 scene_id String 场景id。 scene_name String 场景名称。 type String 场景类型。 service_type String 服务类型。 status String 状态。 workspace_id String 工作空间id。 created_at Integer 创建时间。 update_at Integer 更新时间。 specs_config SpecsConfig object 计算规格。 表5 DataConfig 参数 参数类型 描述 offline Offline object 离线计算规格。 nearline Nearline object 近线数据源。 表6 Offline 参数 参数类型 描述 user_url String 用户数据url。 item_url String 物品数据url。 behavior_url String 行为数据url。 表7 Nearline 参数 参数类型 描述 item_topic Topic object 物品topic。 user_topic Topic object 用户topic。 behavior_topic Topic object 行为topic。 表8 Topic 参数 参数类型 描述 name String 名称。 id String id。 表9 SpecsConfig 参数 参数类型 描述 offline String 离线计算规格。 nearline String 实时计算规格。 rank String 深度学习计算规格。 online_tps Integer 在线服务最大并发数。

响应示例 状态码： 200 OK { "scene" : { "type" : "UI", "service_type" : "rank", "ds_config" : { "time_interval" : 30 }, "specs_config" : { "offline" : "4CU", "nearline" : "2CU", "rank" : "8CU", "online_tps" : 10 }, "scene_name" : "jby-test-0227-4", "category" : "customize", "scene_id" : "f715e1c61f1f40489b2e4594650fffd8", "datasource_id" : "6a3475a7dd11492e8d14f73a3719333b", "status" : "INITIALIZED", "created_at" : 1584628346333, "update_at" : 1584628346333, "workspace_id" : "68887f2a855f45e7ab4850ecc7ca28c2" }, "is_success" : true}

响应示例 状态码： 200 OK { "jobs" : [ { "workspace_id" : "a79b01afa69d4ddc943aa3423fc43531", "resource_id" : "c27aea2b50004187a36fdbd136368895", "job_id" : "a489f06e41434d5cb7e4776de70824df", "job_name" : "11", "description" : "", "platform" : "AIP", "category" : "SERVICE", "job_type" : "infer", "status" : "PRE_STOP", "job_config" : { "flows" : [ { "rules" : [ { "table_name" : "r4-UIREC", "rule_ratio" : 100.0, "priority" : "1" } ], "filter_sets" : [ "f1-FILTER" ], "attr_value_rules_filter" : [ { "attr_values_a" : [ { "name" : "age", "value" : "1" } ], "attr_values_b" : [ { "name" : "author", "value" : "2" } ] } ], "attr_value_rules_reserve" : [ { "attr_values_a" : [ { "name" : "extend_float", "value" : "11" } ], "attr_values_b" : [ { "name" : "author", "value" : "22" } ] } ], "attr_pair_rules_filter" : [ { "attr_pairs" : [ { "party_a" : "age", "party_b" : "author" }, { "party_a" : "extend_float", "party_b" : "author" } ] } ], "attr_pair_rules_reserve" : [ { "attr_pairs" : [ { "party_a" : "extend_float", "party_b" : "category" } ] } ], "deduplication_list" : [ ], "model_version" : "" } ] }, "enable" : 1, "smnEnable" : 0 } ], "is_success" : true}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 is_success Boolean 是否成功。 jobs jobs object 作业详情。 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，时间比例 RAM DOM，个数比例 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}/service-instance 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方式请参见获取项目ID。 resource_id 是 String 资源id。 workspace_id 是 String 工作空间id。 表2 Query参数 参数 是否必选 参数类型 描述 category 是 String 服务类别： SERVICE，在线服务

URI GET /v2.0/{project_id}/workspaces/{workspace_id}/scenes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方式请参见获取项目ID。 workspace_id 是 String 工作空间id。 表2 Query参数 参数 是否必选 参数类型 描述 category 是 String 场景类型： customize，自定义推荐 intelligent，智能场景

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 is_success Boolean 是否成功。 res_scenes Array of res_scene objects 场景列表信息。 message String 返回消息（请求成功时，不返回此字段）。 error_code String 错误码（请求成功时，不返回此字段）。 表5 res_scene 参数 参数类型 描述 category String 类型。 datasource_id String 数据源id。 ds_config DataConfig object 数据源配置。 scene_id String 场景id。 scene_name String 场景名称。 type String 场景类型。 service_type String 服务类型。 status String 状态。 workspace_id String 工作空间id。 created_at Integer 创建时间。 update_at Integer 更新时间。 specs_config SpecsConfig object 计算规格。 表6 DataConfig 参数 参数类型 描述 offline Offline object 离线计算规格。 nearline Nearline object 近线数据源。 表7 Offline 参数 参数类型 描述 user_url String 用户数据url。 item_url String 物品数据url。 behavior_url String 行为数据url。 表8 Nearline 参数 参数类型 描述 item_topic Topic object 物品topic。 user_topic Topic object 用户topic。 behavior_topic Topic object 行为topic。 表9 Topic 参数 参数类型 描述 name String 名称。 id String id。 表10 SpecsConfig 参数 参数类型 描述 offline String 离线计算规格。 nearline String 实时计算规格。 rank String 深度学习计算规格。 online_tps Integer 在线服务最大并发数。

响应示例 状态码： 200 OK { "res_scenes" : [ { "type" : "UI", "service_type" : "rec", "ds_config" : { "time_interval" : 300 }, "specs_config" : { "offline" : "4CU", "nearline" : "2CU", "rank" : "16CU", "online_tps" : 10 }, "scene_name" : "cyd-scene", "category" : "customize", "scene_id" : "01040139fde2434eb7f0dfab597a3614", "datasource_id" : "1f0affe98a7844ca920f47a2b7e7abae", "status" : "PRE_START", "created_at" : 0, "update_at" : 0, "workspace_id" : "68887f2a855f45e7ab4850ecc7ca28c2" }, { "type" : "UI", "service_type" : "rank", "ds_config" : { "time_interval" : 30 }, "specs_config" : { "offline" : "4CU", "nearline" : "2CU", "rank" : "16CU", "online_tps" : 10 }, "scene_name" : "jby-test-0102", "category" : "customize", "scene_id" : "159a4b7ea15a43abb469ef2a7739bae4", "datasource_id" : "6a3475a7dd11492e8d14f73a3719333b", "status" : "INITIALIZED", "created_at" : 0, "update_at" : 0, "workspace_id" : "68887f2a855f45e7ab4850ecc7ca28c2" } ], "is_success" : true}

响应消息 响应参数请参见表2。 表2 响应参数说明 参数名称 参数类型 说明 is_success Boolean 请求是否成功。 specs List 计算资源规格列表，表3。 error_code String 请求失败时的错误码，请求成功时无此字段。 error_msg String 请求失败时的错误信息，请求成功时无此字段。 表3 specs参数说明 参数名称 参数类型 说明 spec_id Long 资源规格的ID。 core String 资源规格的核数。 cpu String 资源规格CPU内存。 gpu_num Int 资源规格GPU的个数。 gpu_type String 资源规格GPU的类型。 spec_code String 云资源的规格类型。 max_num Int 以选择的最大节点数量。 storage String 资源规格的ssd大小。 interface_type Int 接口类型。 no_resource Boolean 所选规格资源是否充足，True代表没有资源。

示例 成功响应示例 { "is_success": true, "specs": [ { "spec_id": 2, "core": "2", "cpu": "8", "gpu_num": 0, "gpu_type": "", "spec_code": "modelarts.vm.cpu.2u", "max_num": 2, "storage": "", "interface_type": 3, "no_resource": false } ]} 失败响应示例 { "is_success": false, "error_code": "res.1006", "error_msg": "The content for the request is invalid." }

请求示例 更新场景的内容 /v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/scenes/testuuidxxxxxxxxxxxxxxxxxxxxxxxx{ "scene_name" : "jby-test-0227-4", "category" : "customize", "type" : "UI", "service_type" : "rank", "datasource_id" : "6a3475a7dd11492e8d14f73a3719333b", "ds_config" : { "time_interval" : 30 }, "specs_config" : { "offline" : "4CU", "nearline" : "2CU", "rank" : "8CU", "online_tps" : 10 }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型，取值为application/json。 X-Auth-Token 是 String 用户token，获取方式请参见获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 category 是 String 场景类型： customize，自定义推荐 popularity，热门推荐 relation，关联推荐 personalization，猜你喜欢 datasource_id 是 String 数据源id，字母、数字、下划线、减号组合32位。 ds_config 是 ds_config object 数据源配置。 scene_name 是 String 场景名称，1-64位的字母、数字、下划线、中划线组合。 最小长度：1 最大长度：64 specs_config 是 SpecsConfig object 计算规格。 type 是 String 场景类型： UI，基于用户推荐物品 UU，基于用户推荐用户 II，基于物品推荐物品 IU，基于物品推荐用户 service_type 是 String 服务类型： rank，排序服务 rec，推荐服务 表4 ds_config 参数 是否必选 参数类型 描述 time_interval 否 Integer 数据选择(天)。 category_type 否 String 物品类别。 表5 SpecsConfig 参数 是否必选 参数类型 描述 offline 是 String 离线计算规格。 nearline 否 String 实时计算规格。 rank 否 String 深度学习计算规格。 online_tps 否 Integer 在线服务最大并发数。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 enterprise_projects Array of enterprise_projects objects 企业项目列表。 is_success Boolean 是否成功。 message String 返回消息（请求成功时，不返回此字段）。 error_code String 错误码（请求成功时，不返回此字段）。 表4 enterprise_projects 参数 参数类型 描述 created_at String 创建时间。 description String 描述。 id String 企业项目id。 name String 企业项目名称。 status Integer 状态。 updated_at String 更新时间。

响应示例 状态码： 200 OK { "is_success" : true, "enterprise_projects" : [ { "id" : "0", "name" : "default", "status" : 1 }, { "id" : "f785ffdf13bd-4e6cbdf614f2d5ec7f78", "name" : "res-developer", "description" : "res-developer-test", "status" : 1, "created_at" : "2019-12-12T06:41:26Z", "updated_at" : "2019-12-12T06:41:26Z" }, { "id" : "5d1c5366e616426a88b70f80c1873f18", "name" : "w1", "status" : 1, "created_at" : "2019-12-10T01:51:08Z", "updated_at" : "2019-12-10T01:51:08Z" }, { "id" : "a82d585fdb934850aedc06e4e534f1b8", "name" : "project1", "status" : 1, "created_at" : "2019-09-25T07:07:11Z", "updated_at" : "2019-09-25T07:07:11Z" } ]}

认证前准备 通过SDK访问APP认证前，需要获取如下信息： 访问服务前，首先需要得到API的ID、请求URL和请求方法 在数据服务的“API目录”页面，单击API名称，在“完整信息”页面查看API的ID、请求URL和请求方法。 图1 API基础定义 对于APP认证的API，您必须提供有效的AppKey、AppSecret才能够生成认证签名。 在“应用管理”中生成一个APP，并将APP绑定到API，就可以使用APP对应的AppKey和AppSecert访问该API。可在应用详细信息中查看AppKey和AppSecret。 图2 查看AppKey和AppSecret AppKey：APP访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 AppSecret：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 发送API请求时，需要将当前时间置于HTTP的X-Sdk-Date头，将签名信息置于Authorization头。签名只在一个有限的时间内是有效的，超时即无效。 父主题： 使用APP认证调用API

SDK使用前准备 下载SDK，并导入对应SDK到本地开发工具，详见认证前准备。 完成appKey、appSecret、method、url等参数填写 表1 参数 参数类型 参数说明 使用示例 path参数 路径参数，作为url的一部分，直接替换url中{}标识的参数 参数: param = xxx 原url: http://域名/p1/{param}/p2 实际url: http://域名/p1/xxx/p2 query参数 查询参数，作为url的补充部分 参数: param = xxx 参数2: param2 = xxx2 示例1： 调用方法添加query参数（以各语言SDK为准） 例: request.addQueryStringParam("param"," xxx"); 示例2： 直接拼接到url后面，以?开头，多个参数以&连接 原url: http://域名/p1 实际url: http://域名/p1?param=xxx¶m2=xxx2 header参数 请求头参数，作为请求头的一部分，参数名不区分大小写 参数: param = xxx 调用方法添加header头参数/构造请求时添加等（以各语言SDK为准） 例：request.addHeader("param"," xxx"); body参数 请求体参数，SDK中输入内容为json字符串（老版本不支持） "{}" 修改SDK，在请求签名后，获取请求头中的签名参数Authorization。并新增参数x-Authorization，值与Authorization相同。获取与新增方式，详见各语言调用文档认证前准备。 父主题： 数据服务SDK参考

SDK列表 表1提供了CDN服务支持的SDK列表，您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 参考文档 Java huaweicloud-sdk-java-v3 Java SDK使用指导 Python huaweicloud-sdk-python-v3 Python SDK使用指导 Go huaweicloud-sdk-go-v3 Go SDK使用指导 .NET huaweicloud-sdk-net-v3 .Net SDK使用指导 PHP huaweicloud-sdk-php-v3 PHP SDK使用指导 Node.js huaweicloud-sdk-nodejs-v3 Node.js SDK使用指导

SAP S/4HANA（HA） 在SAP S/4HANA（HA）场景，主节点上部署AS CS ，备节点上部署ERS，您需要在主备节点都部署监控Agent，具体请参考3.1.3。 hostname填写各自的主机名，instance_number主节点上填写PAS或AAS的实例号，备节点上填写本机上PAS或AAS的实例号，同时在主节点需将application.netweaver的enable配置项改为true，启用监控。 主备上都需安装AAS或者PAS，且进程需启动。 HA切换后，在主节点需将application.netweaver的enable配置项改为false，停止原主节点的监控；在备节点需将application.netweaver的enable配置项改为true，启用新主节点。 父主题： 安装监控Agent

资源和成本规划 表1 资源和成本规划 区域 资源 资源名称 资源说明 数量 每月费用（元） 华南-广州： 模拟华为云（本端） 虚拟私有云VPC vpc-guangzhou VPC网段：10.0.0.0/16 1 00.00 虚拟私有云子网 subnet-1 子网网段：10.0.1.0/24 1 00.00 弹性 云服务器ECS ecs-guangzhou-8 私有IP地址：10.0.1.21 s6.small.1, 1核/1GB, 0.1 / 0.8 Gbit/s, 高IO 40G OS：Windows（参考市场镜像价格） 1 46.20（不包括OS License价格） AOM N/A 应用运维管理 服务。 用于存监控指标以及进行监 控告警 1 00.00（基础版免费） SMN N/A 消息通知 服务。 用于通过短信或邮件的方式 发送监控告警消息。 1 0.045元/条 （总共200条每月，9元） 资源成本费用预估为55.20元，该费用中，不包括OS License价格。 本文提供的成本预估费用仅供参考，资源的实际费用以华为云管理控制台显示为准。

SAP HANA（HA） 在SAP HANA（单节点HA）场景，您需要在主备节点上都部署监控Agent，具体请参考3.1.1。 hostname填写各自的主机名，在主节点将database.hana的enable配置项改为true，启用监控。 HA切换后，在主节点需将database.hana的enable配置项改为false，停止原主节点的监控；在备节点需将database.hana的enable配置项改为true，启用新主节点。 父主题： 安装监控Agent

如何修改SAP监控指标的采集周期 登录安装监控Agent的节点。 执行以下命令，打开监控指标文件“metrics.ini”。 vim /usr/local/sapmon/config/metrics.ini [interval] # unit is minute 1,5,15 database_version = 1 service_quantity = 1 database_ha_active = 1 sr_active = 1 threads = 1 recent_data_backup = 5 recent_savepoint = 1 column_tables_used_memory = 15 schema_used_memory = 15 disk_data_files = 1 disk_usage = 1 service_memory = 1 host_memory = 1 sql_service = 1 sql_top_time = 1 sql_top_mem = 1 connections_total = 1 table_cs_top_mem = 15 system_replication = 1 system_replication_takeover = 1 alerts = 1 # FOR APPLICATION logged_in_users = 1 application_version = 1 instance_quantity = 1 application_ha_active = 1 abap_short_dumps = 1 abap_short_dumps_5m = 5 jobs = 1 lock_entries_usage = 1 extended_memory_utilization = 1 heap_memory_utilization = 1 work_processes = 1 update_records = 1 rfc_ping = 1 failed_idocs = 1 dialog_response_time = 1 dialog_db_request_time = 1 j2ee_running_process = 1 j2ee_thread = 1 j2ee_session = 1 j2ee_websession = 1 j2ee_ejbsession = 1 j2ee_vm_heap_size = 1 按“i”，修改监控指标组的采集周期。 示例如下： database_ha_active = 5 同一个指标组的采集周期是统一控制的，采集周期的单位为分钟，采集周期可选值为1、5、15分钟。 按“Esc”，然后执行“:wq!”命令保存并退出。 父主题： 常见问题

SAP监控大屏配置应用监控成功但没有数据 如果出现大屏配置应用监控成功但没有数据，您可以根据表1中列举的原因进行排除。 表1 故障排除 可能原因 排除方案 大屏配置错误，或配置的应用已删除。 进入编辑模式，检查应用、应用SID、数据库应用、数据库应用SID配置是否符合规划，如有错误，修正并更新配置即可。 应用内的云服务器未安装Agent。 安装Agent，等待几分钟。 Agent数据还在上报周期内。 SAP 监控Agent上报周期最短为每一分钟一次，请等待一分钟后刷新。 云服务器meta信息被误修改。 进入编辑模式，无需修改配置，直接点击更新监控配置，等待几分钟。 metrics.ini 配置文件参数配置错误。 检查对比配置文件与实际应用参数是否一致。 Agent及守护进程异常。 查看agent进程是否正常。 Agent从应用中未拿到数据。 检查/var/log/huawei/sapmon/sap_metrics.log 查看获取指标是否报错。 父主题： 常见问题