华为云用户手册

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不同，使用时请注意。

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

示例 成功响应示例 { "is_success": true, "services": [{ "service_id": "84746641-9af3-4fa6-b6ed-850e1f63416c", "service_name": "res-model-vpc2", "description": "test cusom image", "infer_type": "real-time", "status": "stopped", "is_shared": false, "invocation_times": "0", "failed_times": "0", "publish_time": 1547866687137, "update_time": 1547866687137}]} 失败响应示例 { "is_success": false, "error_code": "res.2301", "error_msg": "Failed to resolve the token from the request." }

响应参数 状态码： 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 更新时间。

响应消息 响应参数请参见表2。 表2 响应参数说明 参数名称 是否必选 参数类型 说明 is_success 是 Boolean 是否成功。 services 是 List 返回服务列表信息，请参见表3。 表3 services参数说明 参数名称 是否必选 参数类型 说明 service_id 是 String 服务ID。 service_name 是 String 服务名称。 description 否 String 服务描述信息。 infer_type 是 String 服务类型，real-time表示实时服务。 status 是 String 服务状态，deploying、running、stopped、concerning。 is_shared 是 Boolean 是否是共享服务。 invocation_times 是 String 服务总调用次数。 failed_times 是 String 服务失败调用次数。 publish_time 是 Long 服务发布时间。 update_time 是 Long 服务更新时间。

响应示例 状态码： 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" } ]}

响应消息 响应参数请参见表2 响应参数说明。 表2 响应参数说明 参数名称 是否必选 参数类型 说明 is_success 是 Boolean 是否成功。 connections 是 List 请参见表3，跨源连接列表。 表3 connections参数说明 参数名称 是否必选 参数类型 说明 id 否 String 标识ID。 cluster_name 是 String 集群名称。 status 否 String 集群状态。 is_register 否 Boolean 是否注册。

示例 成功响应示例 { "is_success": true, "connections": [ { "connection_id": "914ba558-35e1-4fcf-a848-5f193e3b2444", "name": "a", "destination": "cloudtable-res-zk2-rpbIBWT5.cloudtable.com:2181,cloudtable-res-zk3-gqefTdc8.cloudtable.com:2181,cloudtable-res-zk1-3FsKGq9h.cloudtable.com:2181", "state": "FAILED", "cluster_name": "", "service": "CloudTable", "create_time": "1566887641603", "cloudtable_name": "cloudtable-res" } ]} 失败响应示例 { "is_success": false, "error_code": "res.1006", "error_msg": "The content for the request is invalid."}

响应示例 状态码： 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，时间比例 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}/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，效果评估作业

示例 成功响应示例 { "is_success": true, "message": "Succeed to delete computing resource."} 失败响应示例 { "is_success": false, "error_code": "res.1006", "error_msg": "The content for the request is invalid." }

响应参数 状态码： 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 工作空间编号

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 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}

示例 成功响应示例 { "is_success": true, "message":"Succeed to re run job!"} 失败响应示例 { "is_success": false, "error_code": "res.2301", "error_msg": "Failed to resolve the token from the request."}

指标分类 主机OS指标 AOM 主机OS指标详情请参考指标总览 SAP系统指标 SAP系统指标分为SAP HANA指标、SAP NetWeaver ABAP与Java应用指标，详情请参考表1、表2： 表1 SAP HANA指标 指标组 指标名 指标含义 单位 database_version sap_hanadb_database_version_info 数据库版本 - service_quantity sap_hanadb_service_quantity_count 实例进程总数 count sap_hanadb_active_service_quantity_count 实例活跃进程数 count database_ha_active sap_hanadb_database_ha_active_status 数据库HA状态 status sr_active sap_hanadb_sr_active_status 数据库系统复制状态 status threads sap_hanadb_all_threads_count 线程总数 count sap_hanadb_active_threads_count active线程数 count sap_hanadb_blocked_threads_count 阻塞线程数 count sap_hanadb_sqlexecutor_threads_count SQL执行线程数 count sap_hanadb_sqlexecutor_threads_active_count SQL执行active线程数 count sap_hanadb_jobworker_threads_count job工作线程总数 count sap_hanadb_jobworker_threads_active_count job工作线程active线程数 count recent_data_backup sap_hanadb_age_of_recent_data_backup_hours 最近一次成功完全数据备份距现在的时间间隔小时数。如果没有成功备份为-1。 hours recent_savepoint sap_hanadb_age_of_recent_savepoint_minutes 最近一次SAVEPOINT距现在的时间间隔分钟数。没有为-1。 minutes sap_hanadb_recent_savepoint_duration_seconds 最近一次SAVEPOINT的持续时间秒数。没有为-1。 seconds column_tables_used_memory sap_hanadb_column_tables_used_memory_mb 数据表内存使用量 mb ory - - - schema_used_memory sap_hanadb_schema_used_memory_mb 数据库schema内存使用量 mb disk_data_files sap_hanadb_disk_data_files_used_size_mb 数据文件已使用磁盘大小 mb sap_hanadb_disk_data_files_total_size_mb 数据文件磁盘总量 mb sap_hanadb_disk_data_files_available_size_mb 数据文件可用磁盘大小 mb sap_hanadb_disk_data_files_fragmentation_percent 数据文件可用磁盘空间率 percent disk_usage sap_hanadb_disk_total_device_size_mb 操作系统返回的磁盘设备总大小，同一磁盘设备在不同使用类型磁盘设备（DATA、 LOG 等）之间共享时，结果会重复 mb sap_hanadb_disk_total_size_mb 磁盘数据卷总大小，同一磁盘设备在不同使用类型卷（DATA、LOG等）之间共享时，结果会重复 mb sap_hanadb_disk_total_used_size_mb 磁盘数据卷已使用大小，同一磁盘设备在不同使用类型卷（DATA、LOG等）之间共享时，结果会重复 mb sap_hanadb_disk_used_size_mb 按使用类型（DATA、LOG等）统计的已使用磁盘大小 mb service_memory sap_hanadb_memory_service_shared_allocated_mb 服务从内存池分配的共享内存 mb sap_hanadb_memory_service_shared_used_size_mb 服务从内存池分配已使用的共享内存 mb sap_hanadb_memory_service_shared_used_percent 服务从内存池分配已使用的共享内存占服务从内存池分配的共享内存比例 percent sap_hanadb_memory_service_heap_allocated_mb 服务从内存池已分配的堆内存 mb sap_hanadb_memory_service_heap_used_size_mb 服务从内存池分配已使用的堆内存 mb sap_hanadb_memory_service_heap_used_percent 服务从内存池分配已使用的堆内存占服务从内存池已分配的堆内存比例 percent sap_hanadb_memory_service_total_used_mb 服务从内存池已申请使用的总内存 mb sap_hanadb_memory_service_physical_total_mb 服务已使用的总物理内存 mb sap_hanadb_memory_service_virtual_total_mb 服务已使用的总虚拟内存 mb sap_hanadb_memory_service_code_size_mb 服务已使用的代码段大小（包括动态链接库） mb sap_hanadb_memory_service_stack_size_mb 服务已使用的栈大小 mb sap_hanadb_memory_service_compactors_freeable_size_mb 服务内存不足时可释放的内存 mb sap_hanadb_memory_service_compactors_allocated_size_mb 服务内存不足时内存池潜在可释放的内存 mb sap_hanadb_memory_service_alloc_limit_mb 服务最大内存池大小 mb sap_hanadb_memory_service_effective_alloc_limit_mb 服务最大有效内存池大小（考虑其他进程计算出的内存池大小） mb host_memory sap_hanadb_host_memory_physical_total_mb 主机总物理内存 mb sap_hanadb_host_memory_resident_mb 主机常驻（已使用）的物理内存 mb sap_hanadb_host_memory_physical_free_mb 主机空闲物理内存 mb sap_hanadb_host_memory_swap_free_mb 主机空闲交换内存 mb sap_hanadb_host_memory_swap_used_mb 主机已使用交换内存 mb sap_hanadb_host_memory_alloc_limit_mb 主机所有进程可分配的最大内存 mb sap_hanadb_host_memory_used_total_mb SAP HANA 进程从内存池中占用的总内存当前大小 mb sap_hanadb_host_memory_used_peak_mb 实例启动后，SAP HANA 进程从内存池中占用的总内存最大值 mb sap_hanadb_host_memory_pool_size_mb SAP HANA 进程的总内存池大小 mb sap_hanadb_host_memory_code_size_mb SAP HANA 进程的总代码段大小，包括动态链接库 mb sap_hanadb_host_memory_shared_alloc_mb SAP HANA 进程的总共享内存大小 mb sql_service sap_hanadb_sql_service_executions_count 不同类型SQL的执行总次数 count sap_hanadb_sql_service_elapsed_time_ms 不同类型SQL执行的总时间消耗 ms sap_hanadb_sql_service_elap_per_exec_avg_ms 不同类型SQL执行的平均时间消耗 ms sap_hanadb_sql_service_lock_per_exec_ms 不同类型SQL执行的平均锁等待时间 ms sap_hanadb_sql_service_max_ela_time_ms 不同类型SQL执行的最大时间消耗 ms sql_top_time sap_hanadb_sql_top_time_consumers_execution_time_mu SQL语句执行耗时TOP 10 mu sap_hanadb_sql_top_time_consumers_execution_count SQL语句执行耗时TOP 10的总执行次数 count sql_top_mem sap_hanadb_sql_top_mem_consumers_total_execution_memory_size_byte SQL语句内存消耗TOP 10 byte sap_hanadb_sql_top_mem_consumers_execution_count SQL语句内存消耗TOP 10的总执行次数 count connections_total sap_hanadb_connections_total_count 不同类型的连接总数 count table_cs_top_mem sap_hanadb_table_cs_top_mem_total_mb 数据库表内存消耗TOP10 mb sap_hanadb_table_cs_top_mem_estimated_max_mb 数据库表内存消耗TOP10的预估最大内存占用 mb sap_hanadb_table_cs_top_mem_record_count 数据库表内存消耗TOP10的数据行数 count sap_hanadb_table_cs_top_mem_disk_size_mb 数据库表内存消耗TOP10的磁盘占用大小 mb alerts sap_hanadb_alerts_current_rating 数据库告警 rating 表2 SAP NetWeaver ABAP与Java应用指标 指标组 指标名 指标含义 单位 application_version sap_netweaver_application_version_info 应用的版本 - instance_quantity sap_netweaver_instance_quantity_count 应用系统总的实例数 count sap_netweaver_active_instance_quantity_count 应用系统活跃的实例数 count application_ha_active sap_netweaver_application_ha_active_status 应用的HA状态 status abap_short_dumps sap_netweaver_abap_short_dumps_count ABAP Dump数量，过去1小时的ABAP dumps统计 count abap_short_dumps_5m sap_netweaver_abap_short_dumps_5m_count 过去5分钟的ABAP dumps统计 count jobs sap_netweaver_canceled_jobs_count 过去1小时已删除（撤销）的作业数 count sap_netweaver_finished_jobs_count 过去1小时已完成的作业数 count logged_in_users sap_netweaver_logged_in_users_count SAP应用已登录的用户数 count lock_entries_usage sap_netweaver_lock_entries_usage_percent 锁使用率 percent extended_memory_utilization sap_netweaver_extended_memory_utilization_percent extended memory 使用率 percent heap_memory_utilization sap_netweaver_heap_memory_utilization_percent heap memory 使用率 percent dialog_response_time sap_netweaver_dialog_response_time_ms Dialog响应耗时 ms dialog_db_request_time sap_netweaver_dialog_db_request_time_ms Dialog到数据库的请求处理耗时 ms work_processes sap_netweaver_work_processes_utilization_percent 进程使用率，进程类型包括：会话，后台，打印，更新1，更新2 percent sap_netweaver_number_of_total_work_processes_count 进程总数，进程类型包括：会话，后台，打印，更新1，更新2 count sap_netweaver_number_of_free_work_processes_count 空闲进程数，进程类型包括： 会话，后台，打印，更新1，更新2 count jobs sap_netweaver_running_jobs_count 运行中的作业数 count failed_idocs sap_netweaver_failed_idocs_count 失败的idoc文档数 count update_records sap_netweaver_update_records_count 过去1分钟更新请求（update records）数量 count sap_netweaver_failed_updates_count 过去1分钟失败的更新请求（update records）数 count rfc_ping sap_netweaver_rfc_ping_ms 各实例到PAS节点的RFC调用时延 ms j2ee_running_process sap_netweaver_j2ee_running_process_count Java运行进程数量。 count j2ee_thread sap_netweaver_j2ee_thread_count Java线程数量 count j2ee_session sap_netweaver_j2ee_session_count Java session数量 count j2ee_websession sap_netweaver_j2ee_websession_count Java web session数量 count j2ee_ejbsession sap_netweaver_j2ee_ejbsession_count Java EJB session数量 count j2ee_vm_heap_size sap_netweaver_j2eevmheap_size_mb Java进程local classes或local objects堆大小 mb sap_netweaver_j2eevmheap_commitSize_mb Java进程local classes或local objects堆提交大小 mb sap_netweaver_j2eevmheap_maxUsedSize_mb Java进程local classes或local objects堆最大使用大小 mb sap_netweaver_j2eevmheap_initialSize_mb Java进程local classes或local objects堆初始大小 mb sap_netweaver_j2eevmheap_maxSize_mb Java进程local classes或local objects堆最大大小 mb 父主题： 查看监控指标

资源和成本规划 表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系统上云，SAP云上应用监控也被大家日渐关心，由于SAP系统都是企业内的核心业务系统，仅仅IAAS监控难再满足业务的需求，IT运维也日渐趋向于以应用为中心，需要结合SAP应用监控(数据库和中间件)，来确保服务器与应用的正常健康运行，进而保证关键业务系统的高可用性和性能。 该方案构建云上的SAP应用监控系统，提供了如下几种应用监控特性： 提供基于Netweaver ABAP 和 Netweaver JAVA的SAP应用系统平台、HANA数据库的监控；支持SUSE操作系统。 提供原数据监控功能，以及每个指标建议监控频率、告警阀值模板。 提供三个Dashboard示例模板，一是整个Landscape的系统Overview服务运行状态和性能状态；二是NW ABAP的详细指标模板；三是HANA系统的详细监控指标模板。 客户根据需求自定义配置Dashboard和告警机制。

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

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

步骤一：编写模板 首先编写一个简单的模板创建虚拟私有云： tosca_definitions_version: huaweicloud_tosca_version_1_0 #模板的版本信息node_templates: #元素对象定义 myvpc: #虚拟私有云 type: HuaweiCloud.VPC.VPC properties: name: my-vpc #虚拟私有云的名称 cidr: '192.168.0.0/16' #虚拟私有云的网段 模板主要包括如下几部分： tosca_definitions_version：用于标识模板的版本信息。当前AOS支持的版本为huaweicloud_tosca_version_1_0。 node_templates：用于定义该模板中编排的元素对象集合，其中所有对象均为元素（可以是一个应用、一个云服务资源）。上述模板中node_templates定义了一个虚拟私有云myvpc。 type：用于指定编排对象的具体类型，来自元素类型列表，可设置为HuaweiCloud.***（***为资源索引中元素名）。上述模板中定义的虚拟私有云myvpc为HuaweiCloud.VPC.VPC类型。 properties：用于定义元素属性，不同的元素类型会有不同的属性。上述模板中虚拟私有云myvpc具有两个属性name和cidr，分别表示虚拟私有云的名称和虚拟私有云的网段，更多信息请参阅虚拟私有云VPC。 VPC网段范围比较大，可以在VPC中定义一个子网，子网是VPC的IP地址范围内的一个区段。基于上个模板在创建的VPC中定义一个子网： tosca_definitions_version: huaweicloud_tosca_version_1_0 #模板的版本信息node_templates: #元素对象定义 myvpc: #虚拟私有云 type: HuaweiCloud.VPC.VPC properties: name: my-vpc #虚拟私有云的名称 cidr: '192.168.0.0/16' #虚拟私有云的网段 mysubnet: #子网 type: HuaweiCloud.VPC.Subnet properties: name: my-subnet #子网的名称 cidr: '192.168.1.0/24' #子网的网段 gateway: 192.168.1.1 #子网的网关 vpcId: #子网所属VPC的ID get_reference: myvpc dhcpEnable: true #是否为该VPC的子网开启DHCP功能 requirements: #定义子网与VPC的依赖关系 - vpcId: node: myvpc requirements为元素依赖，用于设置为与该元素存在依赖关系的其他元素名称。例如子网依赖VPC，模板中在子网的requirements中定义依赖的node为myvpc。 在模板中定义弹性云服务器： tosca_definitions_version: huaweicloud_tosca_version_1_0 #模板的版本信息node_templates: #元素对象定义 myvpc: #虚拟私有云 type: HuaweiCloud.VPC.VPC properties: name: my-vpc #虚拟私有云的名称 cidr: '192.168.0.0/16' #虚拟私有云的网段 mysubnet: #子网 type: HuaweiCloud.VPC.Subnet properties: name: my-subnet #子网的名称 cidr: '192.168.1.0/24' #子网的网段 gateway: 192.168.1.1 #子网的网关 vpcId: #子网所属VPC的ID get_reference: myvpc dhcpEnable: true #是否为该VPC的子网开启DHCP功能 requirements: #定义子网与VPC的依赖关系 - vpcId: node: myvpc myecs: #弹性云服务器 type: HuaweiCloud.ECS.CloudServer properties: name: my-ecs #云服务器名称 instances: 1 #创建云服务器数量 imageId: 7be2e72e-0679-4a1b-8faf-0c1865708b20 #云服务器使用的镜像ID，本模板中设置为ECS系统盘镜像CentOS 7.4 64bit的镜像ID flavor: c2.large #云服务器的规格 vpcId: #云服务器所属VPC的ID，支持使用已有或新建虚拟私有云ID get_reference: myvpc #用于获取相关联的元素的动态属性值 availabilityZone: cn-south-1a #云服务器对应可用区信息，本模板中使用的是华南-广州区域的一个可用区 nics: #云服务器对应的网卡信息 - subnetId: get_reference: mysubnet rootVolume: #云服务器对应系统盘相关配置 volumeType: SATA #普通IO磁盘类型 size: 40 #系统盘大小，容量单位为GB requirements: #定义弹性云服务器和VPC、子网的依赖关系 - vpcId: node: myvpc - nics.subnetId: node: mysubnet 将模板保存为本地文件myecs.yaml。 登录AOS控制台。 模板中云服务器的镜像ID和可用区使用的是华南-广州区域的CentOS 6.3 64bit的镜像ID和cn-south-1a分区，因此登录控制台时请选择华南-广州区域，否则会导致堆栈创建失败。 选择左侧导航栏的“我的模板”，单击“创建模板”。 选择“上传本地模板”，上传本地yaml文件，单击“创建”，系统自动跳转到模板详情页面，可查看到当前模板信息。 模板名称：自定义模板名称，需确保全局唯一，例如设置为myecs。 版本：设置为1.0。 选择文件：上传本地文件myecs.yaml。 图2 上传本地模板

什么是TOSCA模板？ TOSCA（Topology and Orchestration Specification for Cloud Application）是开放标准联盟OASIS管理的独立技术委员会之一，其发布的云应用拓扑及编排描述规范（简称TOSCA规范）目标是规范多厂商云应用生命周期管理流程。AOS应用拓扑模型如图1所示。 图1 应用拓扑模型 表1 应用拓扑模型节点及关系说明 元素 说明 Resource 资源类节点，如VM、容器等。 AppGroup 云应用组，由一个或多个云应用组成，可整体进行生命周期操作，如部署、升级。也可对应到客户产品、业务系统/子系统等。 Application 运行在资源上的云应用，是对最小可部署对象的一种描述。 其中，MicroService也是一种Application。 SoftwareComponent 软件组件，云应用组件的组成部分，即软件包。也可以作为Application的属性，是可选节点。 Service 应用所依赖的服务。服务是对按需取用的功能对象的一种描述。 DependsOn 节点间的依赖关系，决定了创建顺序，为基础关系。 HostedOn 只能用于Application与Resource之间，表示应用运行在资源上。 ConsistsOf 表示组合关系。 例如，AppGroup由Application组成。 ConnectsTo 表示调用或连接关系。 例如，Application和Application之间，资源与资源之间。 PackageConsistsOf 应用和软件组件之间的组合关系 。 编写模板可参考AOS通过编写模板创建弹性云服务器。 父主题： 应用编排

背景信息 配置完成租户映射关系，且订阅“appcubeAdapter应用创建”应用后，会自动同步ISDP+的订阅OpenAPI的clientId和clientSecret，ISDP+租户ID，调用AppCube的OpenAPI的clientId和clientSecret的值到对应的租户级系统参数comm_isdp_openAPI_clientId、comm_isdp_openAPI_clientSecret、comm_isdp_tenantId、comm_appcube_openAPI_clientId和comm_appcube_openAPI_clientSecret中。

计费原则 计费项 计费规则 欠费说明 号码月租费 每月1日零点对账号下的固话号码（包括“使用中”和“暂停”状态）数量进行统计计费，当月新发放的固话号码则在号码发放当日收取当月月租费。 用户可随时退订号码，退订后从下个月开始不收月租费。 说明： 号码退订后不可恢复，请谨慎操作。 号码退订当月仍会收取整月月租费。 请确保您的华为云账户中余额充足，因余额不足导致扣费失败，欠费冻结会导致业务无法使用，请及时充值。 若保留期满仍未续订或充值，系统会自动退订用户账号下的所有号码。 通话服务费 根据实际通话时长计费，不足一分钟按一分钟计算。 语音回呼根据两路通话时长（主叫通话时长+被叫通话时长）计费。 结算时以小时为周期扣费。

请求消息头 附加请求头字段，如指定的URL和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 消息头名称 描述 是否必选 Content-Type 消息体的类型（格式），HTTP协议中设定的一个参数，用于标识返回的内容用什么格式去解析。 配置为“application/json”，表示浏览器将返回内容解析为json对象。 配置为“application/x-www-form-urlencoded”，表示urlencode格式。 消息体的类型请参见API中API的说明。 是 access-token access-token是调用AppCube接口API要用到的访问令牌，在调用API的时候将access-token加到请求消息头，从而通过身份认证，获得操作API的权限。 当第三方系统要访问AppCube的接口时，需要提前使用OAuth协议进行接入认证，获取客户端鉴权ID（Client ID）和客户端鉴权密钥（Client Secret），再使用客户端鉴权ID和客户端鉴权密钥调用接口“/baas/auth/v1.0/oauth2/token”获取access_token，从而获取AppCube接口的访问令牌。 否 说明： 使用access-token认证时该字段必选。 对于使用OAuth 2.0的客户端鉴权模式获取用户access_token接口，由于不需要access-token认证，所以只添加“Content-Type”为“application/x-www-form-urlencoded”即可，添加消息头后的请求如下所示。 POST https://XXX.huawei.com/baas/auth/v1.0/oauth2/token //XXX.huawei.com为一个示例说明，不是实际的 域名 ，在实际环境中使用时，请替换为实际使用的域名。Content-Type: application/x-www-form-urlencoded

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP请求方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在使用OAuth 2.0的客户端鉴权模式获取用户access_token的URL部分，您可以看到其请求方法为“POST”，则其请求为： POST https://XXX.huawei.com/baas/auth/v1.0/oauth2/token //XXX.huawei.com为一个示例说明，不是实际的域名，在实际环境中使用时，请替换为实际使用的域名。

请求URL 请求URL由如下部分组成： {URL-scheme}://{Endpoint}/{resource-path}?{query-string} 表1 请求URL 参数 说明 URL-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的AppCube服务器域名或IP。 resource-path 资源路径，即API访问路径。从具体API的URL模块获取，例如“获取用户Token”API的resource-path为“/baas/auth/v1.0/oauth2/token”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要使用OAuth 2.0协议的客户端鉴权模式获取用户access_token，“/baas/auth/v1.0/oauth2/token”为资源路径，假设AppCube开发态域名为“XXX.huawei.com”，URL拼接起来如下所示。 https://XXX.huawei.com/baas/auth/v1.0/oauth2/token //XXX.huawei.com为一个示例说明，不是实际的域名，在实际环境中使用时，请替换为实际使用的域名。