华为云用户手册

响应消息 响应参数请参见表2。 表2 响应参数说明 参数名称 参数类型 说明 is_success Boolean 请求是否成功。 indicator_values Map[String，Map[String, Map[String, String]]] 查询到的效果指标，外层map的key表示服务名称，中间层表示流程名称，里层map的key表示时间戳，value表示对应的指标的值。 error_msg String 请求失败时的错误信息，请求成功时无此字段。 error_code String 请求失败时的错误码，请求成功时无此字段。

请求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

响应参数 状态码： 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 服务类型。

请求示例 创建场景 /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}

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 在线服务最大并发数。

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

请求消息 请求参数请参见表2。 表2 请求参数说明 参数名称 是否必选 参数类型 说明 service_name 是 String 服务名称，服务名称必须以res-开头，由数字、字母、下划线、中划线组成，不能以中划线结束，最大长度48字符。 service_type 是 String 服务类型， 可选值为infer、rank、nlp。 description 否 String 服务描述信息。 flows 是 List 流程列表，请参见表3。 表3 flows参数说明 参数名称 是否必选 参数类型 说明 name 是 String 流程名称，由汉字、数字、字母、下划线、中划线、空格组成，最大长度60字符。 rules 是 List 每个Flow配置不同流量和候选集的规则，请参见表4。 backup_uuid 否 String 人工导入召回策略生成的uuid。 need_preferences 否 Boolean 是否开启优选项功能，需匹配global_features_info_path，profile_uuid和attr_weight。例如，在购物车场景，使用的召回候选集来自于离线计算基于物品的协同过滤生成的候选集，而为了尽可能保证推荐的匹配度，要求推荐出来的物品尽可能的与用户性别、体质和年龄等属性吻合，所以考虑基于用户性别、体质和年龄等属性用标签索引得到的满足条件物品列表item1， 对离线生成的items2进行如下处理：先从items2中取在item1中出现的物品，如果个数不够，再从item2中取其余的物品填补。 global_features_info_path 是 String 全局特征配置文件路径。 profile_uuid 否 String 特征工程初始用户画像-物品画像-标准宽表算子生成的uuid。 线上预测需要对候选集进行过滤时为必选项。 attr_weight 否 List 可用于属性权重排序或优选项搜索功能。请参见表11，属性权重列表。 filter_conf 否 Object 请参见表6，过滤配置列表。 rank_conf 否 Object 请参见表9，排序配置列表。 config 是 JSON 请参见表5。 表4 rules参数说明 参数名称 是否必选 参数类型 说明 candidate_uuid 是 String 候选集ID。 rule_ratio 是 Integer 同优先级数据占比（ 0-100 整数 同级别占比和为100）。 priority 是 String 优先级，1-10的整数（1优先级最高），最大长度32。 表5 config参数说明 参数名称 是否必选 参数类型 说明 model_name 是 String 模型名称。 model_version 是 String 模型版本。 weight 是 Integer ABtest流量占比（0-100 整数 所有流程总和为100）。 specification 是 String 节点规格信息， 目前只支持c2.m8.g0。 instance_count 是 Integer 节点实例个数， 最大2个实例。 表6 filter_conf参数说明 参数名称 是否必选 参数类型 说明 filter_uuid 否 String 过滤规则生成的uuid。 线上预测需要对候选集进行属性过滤时为必选项。 duplicate_info 否 Objcet 请参见表7，去重相关的配置。 attribute_rules 否 List 请参见表8，属性过滤相关的配置。 表7 duplicate_info参数说明 参数名称 是否必选 参数类型 说明 item_properties 否 List 要去重的属性列表，例如：填写product_color，则对候选集中相同产品颜色的物品进行去重，留下召回分数高的物品。 item_id_ignore_length 否 String 要忽略的物品ID末尾长度，例如：候选集中有两个物品为SKU_A000123和SKU_A000456，指定忽略长度为3，则对该物品去重，留下召回分数高的物品。。 表8 attribute_rules参数说明 参数名称 是否必选 参数类型 说明 user_attributes 是 List 需过滤的用户的属性（现只支持string和numerical特征的属性），例如：一线城市用户，则属性名为city，属性值为一线城市。 item_attributes 是 List 需过滤的物品的属性（现只支持string和numerical特征的属性），例如：重量为0的物品，则属性名为weight，属性值为0.00。 表9 rank_conf参数说明 参数名称 是否必选 参数类型 说明 model_path 否 String 排序策略生成的模型在obs的文件路径。 etl_uuid 否 String 特征工程中生成排序训练样本生成的uuid。 is_attrWeight_rank 否 Boolean 是否配置属性排序。 表10 config参数说明 参数名称 是否必选 参数类型 说明 weight 是 Integer 设置当前模型版本的流量占比。 specification 是 String 计算节点规格。 instance_count 是 Integer 计算节点个数，即当前版本模型的实例个数。 image_id 否 String 镜像id，跟model_id互斥，二者只能取一。 model_id 是 String 模型id，跟image_id互斥，二者只能选一个。 表11 attr_weight参数说明 参数名称 是否必选 参数类型 说明 attribute 是 String 属性权重匹配排序中的属性，例如年龄（age）。 weight 是 Double 属性权重匹配排序中的权重，例如0.8。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型，取值为application/json 表4 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 数据源名称:，1-64位字母、数字、下划线、中划线组合。 最小长度：1 最大长度：64 data_config 是 DataConfig object 数据配置。 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 在线服务最大并发数。

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

响应消息 响应参数请参见表2。 表2 响应参数说明 参数名称 参数类型 说明 is_success boolean 请求是否成功。 globals object [] 请参见表3，全局配置信息。 error_code String 请求失败时的错误码，请求成功时无此字段。 error_msg String 请求失败时的错误信息，请求成功时无此字段。 表3 globals参数说明 参数名称 参数类型 说明 project_id String 项目编号，用于资源隔离。 user_id String 来自公有云的User ID，用于用户隔离。 type String 指标类型。 parameter String 全局配置参数配置。 data_format String 数据格式，用户属性表、物品属性表，用户操作行为表必填，值可以为“csv”和“json”。 data_param JSON data_format为csv时必填，其他可选。 表4 data_param参数说明 参数名称 是否必选 参数类型 说明 header 是 String 是否显示表头。 true：有表头 false：无表头 delimiter 是 String 分隔符，最大长度10字符。 quote 是 String 引用字符，最大长度10字符。 escape 是 String 转义字符，最大长度10字符。

响应示例 状态码： 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，在线服务

示例 请求示例 { "type": "B2", "driver_memory": "13G", "driver_cores": 1, "executor_memory": "10G", "executor_cores": 3, "num_executors": 5} 成功响应示例 { "is_success": true, "message": "Succeed to update computing resource."} 失败响应示例 { "is_success": false, "error_code": "res.1006", "error_msg": "The content for the request is invalid." }

请求消息 请求参数请参见表2。 表2 请求参数说明 参数名称 是否必选 参数类型 说明 id 是 String 资源id，用于区分各个计算资源。 driver_memory 是 String 驱动内存，大于等于512M(m)，或大于等于1G(g)。 driver_cores 是 Integer 驱动核数，大于等于1。 executor_memory 是 String 运行内存，大于等于512M(m)，或大于等于1G(g)。 executor_cores 是 Integer 运行核数，大于等于1。 num_executors 是 Integer 核数，大于等于1。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 datasources Array of datasources objects 数据源详情列表。 is_success Boolean 是否成功。 message String 返回消息（请求成功时，不返回此字段）。 error_code String 错误码（请求成功时，不返回此字段）。 表4 datasources 参数 参数类型 描述 datasource_id String 数据源id。 datasource_name String 名称。 status String 状态。 structure String 结构。 workspace_id String 工作空间编号。 data_config DataConfig object 数据配置。 specs_config SpecsConfig object 计算规格配置。 created_at String 创建时间。 update_at Long 更新时间。 表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 在线服务最大并发数。

深度网络因子分解机 表37 algorithm_parameters参数说明 参数名称 是否必选 参数类型 说明 fields_feature_size_path 是 String 该文件标识了每一个域下的特征数量，排序数据处理接口会生成这个文件，文件路径为用户在数据处理中输入的“run_path”参数表示的路径的“fields_feature_size”目录下，文件名称为“part-00000”，需要用户提供文件完整路径。 max_iterations 是 Int 模型训练的最大迭代轮数。取值范围[1,1000] early_stop_iterations 是 Int 在测试集上连续early_stop_iterations轮迭代的AUC小于当前最优AUC时，迭代停止，训练结束。取值范围[1,1000]，不大于max_iterations。 algorithm_specify_parameters 是 JSON 请参见表38，算法相关参数。 示例： { “latent_vector_length”：10， “architecture”：[400,400,400]， “value_keep_probability”: 0.8, “active_function”:“reul” } initial_parameters 是 JSON 请参见表32，初始化相关参数。 示例： { “initial_method”:“normal”, “mean_value”: 0.0， “standard_deviation”：0.001 } optimize_parameters 是 JSON 请参见表33，优化策略相关参数。 示例： { “type”:“adam”, “epsilon”：1e-08， “learning_rate”：0.001 } regular_parameters 是 JSON 请参见表34，正则相关参数。 示例： { "l2_regularization":0.001, "regular_loss_compute_mode":"full" } 表38 algorithm_specify_parameters 取值说明 参数名称 是否必选 参数类型 说明 隐向量长度 （latent_vector_length) 是 Int 分解后的特征向量的长度。取值范围[1,100]，默认10。 神经网络结构 (architecture) 是 List[Int] 神经网络的层数与每一层神经元节点个数。每一层神经元节点数不大于5000，神经网络层数不大于10。默认为400,400,400。 神经元值保留概率 (value_keep_probability) 是 Double 神经网络前向传播过程中以该概率保留神经元的值。取值范围(0,1]，默认0.8。 激活函数 (active_function) 是 Enum 将一个（或一组）神经元的值映射为一个输出值。取值为relu/sigmoid/tanh，默认relu。

核函数特征交互神经网络 表39 algorithm_parameters参数说明 参数名称 是否必选 参数类型 说明 fields_feature_size_path 是 String 该文件标识了每一个域下的特征数量，排序数据处理接口会生成这个文件，文件路径为用户在数据处理中输入的“run_path”参数表示的路径的“fields_feature_size”目录下，文件名称为“part-00000”，需要用户提供文件完整路径。 max_iterations 是 Int 模型训练的最大迭代轮数。取值范围[1,1000]，默认50。 early_stop_iterations 是 Int 在测试集上连续early_stop_iterations轮迭代的AUC小于当前最优AUC时，迭代停止，训练结束。取值范围[1,1000]，不大于max_iterations，默认5。 algorithm_specify_parameters 是 JSON 请参见表40，算法相关参数。 示例： { "latent_vector_length":10, "active_function":"relu", "architecture":[400,400,400], "value_keep_probability":0.8, "sub_net_architecture":[40,5], "is_drop_fm":"False" } initial_parameters 是 JSON 请参见表32，初始化相关参数。 示例： { “initial_method”:“xavier” } optimize_parameters 是 JSON 请参见表33，优化策略相关参数。 示例： { “type”:“adam”, “epsilon”：1e-08， “learning_rate”：0.001 } regular_parameters 是 JSON 请参见表34，正则相关参数。 示例： { "l2_regularization":0.001, "regular_loss_compute_mode":"full" } 表40 algorithm_specify_parameters 取值说明 参数名称 是否必选 参数类型 说明 隐向量长度 （latent_vector_length) 是 Int 分解后的特征向量的长度。取值范围[1,100]，默认10。 神经网络结构 (architecture) 是 List[Int] 神经网络的层数与每一层神经元节点个数。每一层神经元节点数取值范围为[1,1000]，神经网络层数不大于5。默认400,400,400。 神经元值保留概率 (value_keep_probability) 是 Double 神经网络前向传播过程中以该概率保留神经元的值。取值范围(0,1]，默认0.8。 激活函数 (active_function) 是 Enum 将一个（或一组）神经元的值映射为一个输出值。取值relu/sigmoid/tanh，默认relu。 子网络结构 (sub_net_architecture) 是 List[Int] 特征向量之间使用神经网络核来计算相互关系时，该神经网络的结构。每一层的节点数取值范围为[1,100]，深度不超过5层。默认40,5。 是否移除因子分解机 (is_drop_fm) 是 Boolean 是否移除模型架构中的因子分解机部分，值为True则蜕变为带有核函数的DNN。取值true/false，默认false。

因子分解机 表35 algorithm_parameters参数说明 参数名称 是否必选 参数类型 说明 fields_feature_size_path 是 String 该文件标识了每一个域下的特征数量，排序数据处理接口会生成这个文件，文件路径为用户在数据处理中输入的“run_path”参数表示的路径的“fields_feature_size”目录下，文件名称为“part-00000”，需要用户提供文件完整路径。 max_iterations 是 Int 模型训练的最大迭代轮数。取值范围[1,1000]。 early_stop_iterations 是 Int 在测试集上连续early_stop_iterations轮迭代的AUC小于当前最优AUC时，迭代停止，训练结束。取值范围[1,1000]，不大于max_iterations。 algorithm_specify_parameters 是 JSON 请参见表36，算法相关参数。 示例： { “latent_vector_length”:10 } initial_parameters 是 JSON 请参见表32，初始化相关参数。 示例： { “initial_method”:“normal”, “mean_value”: 0.0， “standard_deviation”:0.001 } optimize_parameters 是 JSON 请参见表33，优化策略相关参数。 示例： { “type”:“adam”, “epsilon”：1e-08， “learning_rate”：0.001 } regular_parameters 是 JSON 请参见表34，正则相关参数。 示例： { "l2_regularization":0.001, "regular_loss_compute_mode":"full" } 表36 algorithm_specify_parameters 取值说明 参数名称 是否必选 参数类型 说明 隐向量长度（latent_vector_length) 是 Int 分解后的特征向量的长度。取值范围[1,1000]，默认值10。

逻辑斯蒂回归 表31 algorithm_parameters参数说明 参数名称 是否必选 参数类型 说明 fields_feature_size_path 是 String 该文件标识了每一个域下的特征数量，排序数据处理接口会生成这个文件，文件路径为用户在排序数据预处理中输入的结果保存路径参数表示的路径的“fields_feature_size”目录下，文件名称为“part-00000”，需要用户提供文件完整路径。 max_iterations 是 Int 模型训练的最大迭代轮数。取值范围[1,1000]。 early_stop_iterations 是 Int 在测试集上连续early_stop_iterations轮迭代的AUC小于当前最优AUC时，迭代停止，训练结束。取值范围[1,1000]，不大于max_iterations。 initial_parameters 是 JSON 请参见表32，初始化相关参数。 示例： { “initial_method”:“normal”,“mean_value”: 0， “standard_deviation”:0.001 } optimize_parameters 是 JSON 请参见表33，优化策略相关参数。 示例： { “type”:“adam”, “epsilon”：1e-08， “learning_rate”：0.001 } regular_parameters 是 JSON 请参见表34，正则相关参数。 示例： { "l2_regularization":0.001, "regular_loss_compute_mode":"full" } algorithm_specify_parameters 是 JSON - 表32 initial_parameters 参数说明 参数名称 是否必选 参数类型 说明 正态分布(normal) 平均值(mean_value) 是 Double 正态分布的平均值。取值范围[-1,1]，默认值为0。 标准差(standard_deviation) 是 Double 正态分布的标准差。取值范围[0, 1]，默认值为0.001。 均匀分布(uniform) 最小值(min_value) 是 Double 均匀分布的最小值， 必须小于最大值。取值范围[-1, 0)，默认值为-0.001。 最大值(max_value) 是 Double 均匀分布的最大值， 必须大于最小值。取值范围(0,1]，默认值为0.001。 xavier 无 是 无 神经元的初始值权重初始化为均值为0，方差为 Var(wi)=1/nin 的均匀分布（高斯或者随机分布）。其中 nin 是该神经元的输入数目。 表33 optimize_parameters 参数说明 参数名称 是否必选 参数类型 说明 梯度下降(grad) 学习率(learning_rate) 是 Double 决定优化器在优化方向上前进步长的参数。取值范围(0,1]，默认值为0.001。 自适应梯度(adagrad) 初始梯度累加和 (initial_accumulator_value) 是 Double 用来动态调整学习步长。取值范围(0,1]，默认值为0.1。 学习率(learning_rate) 是 Double 决定优化器在优化方向上前进步长的参数。取值范围(0,1]，默认值为0.001。 自适应矩估计(adam) 数值稳定常量(epsilon) 是 Double 为保证数值稳定而设置的一个微小常量。取值范围(0,1]，默认值为1.00E-08。 学习率(learning_rate) 是 Double 决定优化器在优化方向上前进步长的参数。取值范围(0,1]，默认值为0.001。 在线学习(ftrl) 初始梯度累加和 (initial_accumulator_value) 是 Double 用来动态调整学习步长。取值范围(0,1]，默认值为0.1。 L1正则项系数(lambda1) 是 Double 叠加在模型的1范数之上，用来对模型值进行限制防止过拟合。取值范围[0,1]，默认值为0。 L2正则项系数(lambda2) 是 Double 叠加在模型的2范数之上，用来对模型值进行限制防止过拟合。取值范围[0,1]，默认值为0。 学习率(learning_rate) 是 Double 决定优化器在优化方向上前进步长的参数。取值范围(0,1]，默认值为0.1。 表34 regular_parameters参数说明 参数名称 是否必选 参数类型 说明 L2正则项系数 (l2_regularization) 是 Double 叠加在模型的2范数之上，用来对模型值进行限制防止过拟合。取值范围[0,1]，默认值为0。 正则损失计算方式 (regular_loss_compute_mode) 是 enum full指针对全量参数计算，batch则仅针对当前批数据中出现的参数计算，batch模式计算速度快于full模式。默认full。

基于历史行为记忆生成候选集 表20 HistoryBehaviorMemory参数说明 参数名称 是否必选 参数类型 说明 data_source_config 是 JSON 请参见表21，数据源参数配置。 algorithm_config 是 JSON 请参见表22，算法参数配置。 candidate_set_config 是 JSON 候选集参数配置。 表21 data_source_config参数说明 参数名称 是否必选 参数类型 说明 retain_days 是 Integer 用户行为时间跨度 ，整数 [1,10000]。 表22 algorithm_config参数说明 参数名称 是否必选 参数类型 说明 history_behavior_memories 是 List 请参见表23，历史行为记忆。 表23 his_behavior_memos参数说明 参数名称 是否必选 参数类型 说明 behavior_type 是 String 行为类型。 view：物品曝光 click：用户点击物品 collect：用户收藏了某个物品 uncollect：用户取消收藏某个物品 search_click：用户点击搜索结果中的物品 comment：用户对物品的评论 share: 分享 like：点赞 dislike：点衰 grade：评分 consume：消费 use：观看视频/听音乐/阅读 least_intension 是 Integer 最低强度，整数[1,100]。

基于用户的协同过滤推荐 表13 UserCF参数说明 参数名称 是否必选 参数类型 说明 data_source_config 是 JSON 请参见表14，数据源参数配置。 algorithm_config 是 JSON 请参见表15，算法参数配置。 candidate_set_config 是 JSON 请参见表16，候选集参数配置。 表14 data_source_config参数说明 参数名称 是否必选 参数类型 说明 retain_days 是 Integer 用户行为时间跨度，整数 [1,10000]。 behavior_weights 是 List 请参见表7（不包含uncollect和dislike），行为权重。 表15 algorithm_config参数说明 参数名称 是否必选 参数类型 说明 similar_metric 是 String 相似性度量方式（“cosine”）。 user_nn 是 Integer 用户最近邻域数，正整数 [1,100000000]。 表16 candidate_set_config参数说明 参数名称 是否必选 参数类型 说明 max_recommended_num 是 Integer 最大推荐结果数，正整数 [1,10000]。

基于交替最小二乘的矩阵分解推荐 表17 AlsCF参数说明 参数名称 是否必选 参数类型 说明 data_source_config 是 JSON 请参见表18，数据源参数配置。 algorithm_config 是 JSON 请参见表19，算法参数配置。 candidate_set_config 是 JSON 候选集参数配置。 表18 data_source_config参数说明 参数名称 是否必选 参数类型 说明 retain_days 是 Integer 用户行为时间跨度，整数[ 1,10000]。 behavior_weights 是 List 请参见表7，行为权重。 表19 algorithm_config参数说明 参数名称 是否必选 参数类型 说明 implicit_vector_rank 是 Integer 隐向量维度，整数[ 1,1000]。 max_iterator_num 是 Integer 最大迭代次数， 整数 [1,2000)。 regular_param 是 Double 正则化系数，大于0 小于等于1，小数最多保留8位）。

基于属性匹配的召回策略 表26 BehaviorsWeight参数说明 参数名称 是否必选 参数类型 说明 portrait_storage 是 JSON 请参见表27，用户画像，物品画像的存储信息。 global_features_information_path 是 String 全局特征信息文件。 match_feature_pairs 是 List 请参见表30，待匹配特征对。 recommended_number 是 Integer 输出的推荐个数【1~1000】。 row 是 Integer 行数。 band 是 Integer 条数。 表27 portrait_storage参数说明 参数名称 是否必选 参数类型 说明 item_profile_storage 是 JSON 请参见表28，用户画像存储信息。 user_profile_storage 是 JSON 请参见表28，用户画像存储信息。 表28 item_profile_storage、user_profile_storage参数说明 参数名称 是否必选 参数类型 说明 platform 是 String 平台名称，现支持CloudTable。 platform_parameter 是 JSON 请参见表29，数据存储参数。 表29 platform_parameter 参数说明 参数名称 是否必选 参数类型 说明 cluster_id 是 String 集群ID。 table_name 是 String 表名称，最大长度64字符。 cluster_name 否 String 集群名称。 表30 match_feature_pairs参数说明 参数名称 是否必选 参数类型 说明 user_feature_name 是 String 用户特征。 item_feature_name 是 String 物品特征。 alias 是 String 别名。 weight 是 String 权重值，默认为1。

基于物品的协同过滤推荐 表9 ItemCF参数说明 参数名称 是否必选 参数类型 描述信息 data_source_config 是 JSON 请参见表10，数据源参数配置。 algorithm_config 是 JSON 请参见表11，算法参数配置。 candidate_set_config 是 JSON 请参见表12，候选集参数配置。 表10 data_source_config参数说明 参数名称 是否必选 参数类型 说明 retain_days 是 Integer 用户行为时间跨度，整数 [1,10000]。 behavior_weights 是 List 请参见表7（不包含uncollect和dislike），行为权重。 表11 algorithm_config参数说明 参数名称 是否必选 参数类型 说明 similar_metric 是 String 相似性度量方式（'cosine'）。 表12 candidate_set_config参数说明 参数名称 是否必选 参数类型 说明 max_recommended_num 是 Integer 最大推荐结果数，正整数[ 1,10000]。