-
SDK部署使用是否有宽限期? iDME内置SDK服务部署使用及宽限期说明 对于已购买MBM SDK和数据建模引擎SDK的华为账号,iDME将提供相应SDK的试用服务。自应用首次生成SDK成功之日起,MBM SDK和xDM-F SDK均可试用30天。同一华为账号下,所有应用生成的xDM-F SDK,其总的试用期限为180天。SDK试用到期后,若无有效License授权将停止使用。 xDM-F SDK和MBM SDK的运行由License进行授权控制,购买SDK服务成功后,建议您及时申请License。 License授权有效期:License授权自申请License之日起即激活,授权有效期为下单SDK服务时的购买时长。 License授权宽限期:为确保您的xDM-F SDK或MBM SDK正常使用以及License授权到期前后有充足时间进行调整,在License授权到期后将进入30天的宽限期。宽限期内您的xDM-F SDK或MBM SDK依旧可以正常使用,宽限期后如果您未进行续费将无法使用相对应的SDK。 第三方SDK服务部署使用及宽限期说明 iDME集成的SDK服务受第三方规定的服务使用限制条件约束,具体以第三方服务提供商的规定为准。
-
SDK服务的计费项是什么? iDME内置的SDK服务按照用户数收费,计费项只有“基础版 数据建模引擎 用户”,计费模式为包年/包月(提供包1年、包3年和包5年三种规格)。选择“通用SDK”组件时,用户的起购数量为50;选择“MBM SDK”组件时,用户的起购数量是100。 iDME集成的第三方SDK服务包含三种计费的计算单元,计费项包括“基础版 数据建模引擎 用户”、“基础版 数据建模引擎 节点”和可自定义量纲换算的“数字主线引擎 MCU”,计费模式均为包年/包月(提供包1年、包3年和包5年三种规格)。在购买时,请根据元服务实际显示的计算单元进行配置,费用将根据您所设置的计算单元数量及使用时长来计算。
-
日志配置 数据建模引擎运行SDK集成了WSF框架和SSF框架,默认打印日志的等级为INFO,您可以通过如下参数说明修改打印日志的等级。 配置参数 是否必选 参数说明 示例 WSF_
LOG _LEVEL 否 用于设置打印WSF框架日志的日志等级。如果未设置此配置参数,则默认打印INFO日志。 ALL TRACE DEBUG INFO WARN ERROR FATAL OFF INFO SSF_LOG_LEVEL 否 用于设置打印SSF框架日志的日志等级。如果未设置此配置参数,则默认打印INFO日志。 ALL TRACE DEBUG INFO WARN ERROR FATAL OFF INFO
-
流程引擎流程SDK配置 数据建模引擎运行SDK和流程引擎流程SDK是独立部署的两个微服务,服务之间可以通过jwt-token认证并进行通信交互。如果您需要开启两个微服务之间的联动,使用流程引擎流程SDK,您需要先在数据建模引擎运行SDK的启动配置文件中添加如下配置。 配置参数 是否必选 参数说明 示例 JWT_WORKFLOW_PRIVATEKEY 是 xDM-F和流程引擎通信时,jwt-token认证鉴权所使用的加密私钥。 如何获取jwt-token认证鉴权所使用的加密私钥,请参见如何生成jwt-token?。 private_key JWT_WORKFLOW_PUBLICKEY 是 xDM-F和流程引擎通信时,jwt-token认证鉴权所使用的加密公钥。 如何获取jwt-token认证鉴权所使用的加密公钥,请参见如何生成jwt-token?。 public_key WORKFLOW_URL 是 流程引擎服务主页的URL。 URL格式: http://{流程引擎流程SDK部署服务器的IP地址}:{流程引擎流程SDK部署服务器的端口号}/{流程引擎流程SDK文根}/index.html http://127.0.0.1:60001/workflowDesign/index.html DATA_SYNC_SWITCH 是 设置是否开启xDM-F和流程引擎间的数据同步。 如需使用流程引擎,此配置参数必须设置为true。 true:开启xDM-F和流程引擎间的数据同步。 false:关闭xDM-F和流程引擎间的数据同步,默认为false。 true
-
License配置 数据建模引擎运行SDK的运行由License进行授权控制。当您已完成“通用SDK”基础版数据建模引擎的购买并获取License文件之后,可参考如下配置说明绑定License。 如果您当前暂未申请License,且获取的SDK包处于试用期,可跳过此配置。 配置参数 是否必选 参数说明 示例 xdm.license.public-key 是 License文件对应的公钥。 发放License文件时会同步提供公钥,如果您收到的文件中无该公钥,请通过提交工单联系我们获取。 iDME SDK:1:5:A9D150C6F*** xdm.license.licenseFile 否 License文件的绝对路径。 /root/deploytest/test.dat xdm.license.deployType 否 数据建模引擎运行SDK部署位置。 MACHINE:虚拟机或物理机。 CONTAINER:容器。 MACHINE xdm.license.runtime.valid-type 否 设置应用运行态许可证激活模式。 LICENSE:许可证模式,默认采用配置LICENSE。 TRIAL:试用模式。 LICENSE
-
WSF配置 数据建模引擎运行SDK的运行时默认启用Huawei WSF安全校验,包括参数校验、文件上传校验等。您可以通过如下配置说明,自定义配置WSF校验规则。 如果您希望精细化管理安全校验,开启dme-WSF组件后,您可以通过自定义配置参数校验、文件上传校验、多文件上传解释器、
CS RF防护过滤器、WSF参数校验文件路径、WSF文件上传配置信息路径等参数实现。 为了避免文件上传校验异常,开启/关闭WSF的文件上传校验时,须同时开启/关闭WSF的多文件上传解释器。即,“dme.wsf.upload.check.enable”和“dme.wsf.multipart.check.enable”同时配置为“true”或“false”。 如需自定义参数校验规则,请遵循WSF组件规则定义对应的XML配置信息。 如果您想使用其他安全防护资源进行安全校验,需要关闭WSF安全校验时,请同时关闭dme-WSF组件和WSF组件。即,“dme.wsf.enable”和“devspore.security.wsf.enable”均配置为“false”。关闭WSF安全校验后,数据建模引擎运行SDK上的数据将不再受保护,请谨慎操作。 配置参数 是否必选 参数说明 示例 dme.wsf.enable 否 dme-WSF组件是iDME基于WSF封装的组件。 如果不配置或配置为true,则开启dme-WSF组件;如果配置为false,则关闭dme-WSF组件。 true devspore.security.wsf.enable 否 WSF自带组件。 如果不配置或配置为true,则开启WSF自带组件;如果配置为false,则关闭WSF组件。 true dme.wsf.param.check.enable 否 WSF的参数校验。 如果不配置或配置为true,则开启参数校验;如果配置为false,则关闭参数校验。 仅当“dme.wsf.enable”为“true”时,此配置参数才有效。 true dme.wsf.param.config.path 否 自定义WSF参数校验规则的文件夹路径。 如果不配置,默认读取当前SDK类路径下“validate”文件夹中的配置。 仅当“dme.wsf.param.check.enable”为“true”时,此配置参数才有效。 /root/deploytest/validate dme.wsf.upload.check.enable 否 WSF的文件上传校验。 如果不配置或配置为true,则开启文件上传校验;如果配置为false,则关闭文件上传校验。 仅当“dme.wsf.enable”为“true”时,此配置参数才有效。 true dme.wsf.multipart.check.enable 否 WSF的多文件上传解释器。 如果不配置或配置为true,则开启多文件上传解释器;如果配置为false,则关闭多文件上传解释器。 仅当“dme.wsf.enable”为“true”时,此配置参数才有效。 true dme.wsf.upload.config.path 否 自定义WSF文件上传校验规则的文件路径。 如果不配置,默认使用iDME配置文件路径。 仅当“dme.wsf.upload.check.enable”为“true”时,此配置参数才有效。 /root/deploytest/CustomUploadFileConfig.properties dme.wsf.csrf.check.enable 否 CSRF防护过滤器。 如果不配置或配置为true,则开启CSRF防护过滤器;如果配置为false,则关闭CSRF防护过滤器。 仅当“dme.wsf.enable”为“true”时,此配置参数才有效。 true
-
特性开关配置 您可以通过如下配置说明,自主控制是否开启/关闭某个xDM-F的功能。 配置参数 是否必选 参数说明 示例 OPEN_SECOND_LEVEL_CACHE 否 设置是否开启二级缓存功能。 true:开启二级缓存,默认为true。 false:关闭二级缓存。 关于二级缓存的介绍请参见数据建模引擎支持哪些层级的缓存?。 false THIRD_LEVEL_REDIS_CLOSED 否 设置是否开启三级缓存功能。 true:关闭三级缓存。 false:开启三级缓存,默认为false。 关于三级缓存的介绍请参见数据建模引擎支持哪些层级的缓存?。 true DYNAMIC_DATASOURCE_ENABLED 否 设置是否开启多数据源功能。 true:开启多数据源。 false:关闭多数据源,默认为false。 false
-
APIG配置 如果您已在数据建模引擎运行SDK资源规划中规划了APIG服务,并希望通过APIG对应用运行态的全量数据服务API进行统一监控、管理、配置、流控等,可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 APIG_HOST 是 承载APIG服务的服务器
域名 或IP地址。 https://apig.cn-north-4.myhuaweicloud.com APIG_INSTANCE_ID 是 APIG的实例ID。 123456 APIG_DEFAULT_GROUP_HOST 是 APIG服务默认组的IP地址。 http://127.0.0.1/ APIG_DEFAULT_GROUP_ID 是 APIG服务默认组的ID。 123456 APIG_ENDPOINT 是 承载APIG服务终端的服务器域名或IP地址。 https://2c3cffb0f7174591a37f40bf5415546e.apic.cn-north-4.myhuaweicloud.com
-
Token配置 如果您希望可以通过Token认证调用应用运行态的全量数据服务API,可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 OPEN_
IAM _TOKEN_VALIDATION 否 设置是否开启Token认证。 true:开启Token认证。 false:关闭Token认证,默认为false。 false IAM_END_POINT 是 承载IAM服务验证Token的服务器域名或IP地址。 https://iam.cn-north-4.myhuaweicloud.com
-
单点登录配置 如果您希望通过单点登录的方式访问应用运行态,可参考如下说明进行配置。xDM-F的SDK部署模式当前支持如下两种单点登录方式,请根据实际的数据建模引擎运行SDK资源规划进行配置。 IAM服务的单点登录 此单点登录方式依赖华为云IAM服务,部分场景下SDK启动后可能无法正常访问IAM服务进行鉴权。建议使用本地环境的单点登录,并确认已规划相关资源。 配置参数 是否必选 参数说明 示例 ssf.sysmgr.sessionfilter.loginUrl 是 IAM服务的单点登录地址。 格式为: https://{IAM_LOGIN_ENDPOINT}/authui/login.action?service={ssf.login.cas.serviceUrl} https://auth.huaweicloud.com/authui/login.action?service=http://127.0.0.1:8003/rdm_123456_app/services/v1/cas/login ssf.sysmgr.sessionfilter.ignorePattern 是 忽略会话校验的URL格式。 /v1/cas/login;/v1/health;/wopi/files/\d{18};/wopi/files/\d{18}/contents;/v1/oauth2/login ssf.login.loginSuccessRedirectUrl 是 登录应用运行态后的默认主页。 格式为: http://{数据建模引擎运行SDK部署服务器的IP地址}:{数据建模引擎运行SDK部署服务器的端口号}/rdm_{应用ID}_app/services/index.html http://127.0.0.1:8003/rdm_123456_app/services/index.html ssf.login.cas.serviceUrl 是 应用运行态的单点登录地址。 格式为: http://{数据建模引擎运行SDK部署服务器的IP地址}:{数据建模引擎运行SDK部署服务器的端口号}/rdm_{应用ID}_app/services/v1/cas/login http://127.0.0.1:8003/rdm_123456_app/services/v1/cas/login ssf.login.logoutUri 是 IAM服务的单点登出地址。 格式为: https://{IAM_LOGIN_ENDPOINT}/authui/logout https://auth.huaweicloud.com/authui/logout ssf.login.cas.validateUrl 是 IAM验签地址。 格式为: https://{IAM_LOGIN_ENDPOINT}/authui/serviceValidate https://auth.huaweicloud.com/authui/serviceValidate IAM_LOGIN_ENDPOINT 是 承载IAM服务的服务器域名或IP地址。 https://auth.huaweicloud.com LOGIN_URL 是 IAM服务的单点登录地址。 格式为: https://{IAM_LOGIN_ENDPOINT}/authui/login.action https://auth.huaweicloud.com/authui/login.action LOGOUT_URL 是 应用运行态的单点登出地址。 格式为: https://{IAM_LOGIN_ENDPOINT}/authui/logout https://auth.huaweicloud.com/authui/logout XDM_SDK_DEPLOY_ENABLE 是 表示当前部署方式是否为SDK部署。 true:是SDK部署方式,默认为true。 false:不是SDK部署方式。 true ssf.sysmgr.sessionfilter.enabled 否 设置是否开启会话认证。 true:开启会话认证,默认为true。 false:关闭会话认证。 true 本地环境的单点登录 配置此方式的单点登录之前,您需要先在数据建模引擎运行SDK资源规划的数据库资源中创建一个schema,其schema名称格式为{应用运行态的schema名称}_ssf;然后在schema中执行如下命令,更新配置信息。 set global log_bin_trust_function_creators=true; 配置参数 是否必选 参数说明 示例 XDM_LOGIN_TYPE 是 应用运行态的登录类型,配置为“LOCAL”。 LOCAL ssf.sysmgr.sessionfilter.loginUrl 是 本地环境的单点登录地址。 LOCAL ssf.sysmgr.sessionfilter.ignorePattern 是 设置忽略请求格式。 /getIndexUrl;/v1/health;/v1/login/login;/v1/login/logout;/v1/login/verifycode;/v1/firstlogin/users;/v1/firstlogin/userpasswords:PUT;/static/**;/index.html;/HuaweiLog.ico;/HuaweiLog.png ssf.login.logoutUri 是 本地环境的单点登出地址。 格式为: https://{数据建模引擎运行SDK部署服务器的IP地址}:{数据建模引擎运行SDK部署服务器的端口号}/rdm_{应用ID}_app/services/index.html http://127.0.0.1:8003/rdm_123456_app/services/index.html OPEN_IAM_TOKEN_VALIDATION 是 设置是否开启Token认证。 true:开启Token认证。开启后,您还需要进行Token配置。 false:关闭Token认证,默认为FALSE。 FALSE RUNTIME_ENV_TYPE 是 设置应用运行态的运行环境,配置为“IES”。 IES SSF_RDS_TYPE 否 本地环境单点登录的数据库类型,默认为“mariadb”。 请根据实际的数据建模引擎运行SDK资源规划进行设置。 如果是MySQL类型数据库,设置为“mariadb”。 如果是PostgreSQL类型数据库,设置为“postgresql”。 mariadb SSF_DRIVER 否 本地环境单点登录的数据库驱动,默认为“org.mariadb.jdbc.Driver”。请根据实际的数据建模引擎运行SDK资源规划进行设置。 如果是MySQL类型数据库,设置为“org.mariadb.jdbc.Driver”。 如果是PostgreSQL类型数据库,设置为“org.postgresql.Driver”。 org.mariadb.jdbc.Driver spring.datasource.ssf.url 否 本地环境单点登录的数据库连接地址。 格式为: jdbc:{SSF_RDS_TYPE}://{RDS_IP}:{RDS_PORT}/{RDS_DATABASE}_ssf?stringtype=unspecified 其中,“RDS_IP”、“RDS_PORT”和“RDS_DATABASE”字段需与配置数据库的配置参数保存一致,“SSF_RDS_TYPE”字段需与配置本地环境的单点登录的配置参数保存一致。 jdbc:postgresql://127.0.0.1:5432/test_ssf?stringtype=unspecified XDM_SDK_DEPLOY_ENABLE 是 表示当前部署方式是否为SDK部署。 true:是SDK部署方式,默认为true。 false:不是SDK部署方式。 true ssf.sysmgr.sessionfilter.enabled 否 设置是否开启会话认证。 true:开启会话认证,默认为true。 false:关闭会话认证。 true
-
MongoDB配置 如果您已在数据建模引擎运行SDK资源规划中规划了MongoDB的资源/云服务,并希望使用xDM-F的“系统版本”功能,可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 mongodb.init 否 设置是否开启MongoDB。 true:开启MongoDB,默认为true。开启后,需要设置“MONGODB_URI”和“MONGODB_DATABASE”参数。 false:关闭MongoDB。 true MONGODB_URI 仅当“mongodb.init”为“true”时,此配置参数必选。 MongoDB的连接串。 mongodb://rwuser:admin@127.0.0.1:8635/test?authSource=admin MONGODB_DATABASE 仅当“mongodb.init”为“true”时,此配置参数必选。 MongoDB的库名。 test
-
Elasticsearch配置 如果您已在数据建模引擎运行SDK资源规划中规划了Elasticsearch的资源/云服务,并希望使用xDM-F的“搜索服务管理”功能,可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 ES_URL 是 Elasticsearch的连接串。 127.0.0.1:9200 ES_PORT 是 Elasticsearch的端口号。 9200 ES_USERNAME 是 Elasticsearch的用户名。 admin ES_PASSWORD 是 Elasticsearch的密码。 admin ES_SCHEMA 是 Elasticsearch的类型。 http
-
Kafka配置 如果您已在数据建模引擎运行SDK资源规划中规划了Kafka的资源/云服务,并希望使用xDM-F的“同步至LinkX-F”功能,可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 kafka.init 否 设置是否开启Kafka。 true:开启Kafka,默认为true。开启后,需要设置“KAFKA_BOOTSTRAP_SERVERS”参数。 false:关闭Kafka。 true KAFKA_BOOTSTRAP_SERVERS 仅当“kafka.init”为“true”时,此配置参数必选。 Kafka的连接地址。 127.0.0.1:9094
-
S3配置 如果您已在数据建模引擎运行SDK资源规划中规划了S3,并希望将应用运行态的所有文件都存储至S3,可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 xdm.objectstorage.type 是 表示对象存储类型,默认设置为“OBS”。 如果您计划使用MinIO服务,则需要将该配置项更改为“S3”。 OBS xdm.objectstorage.s3.host 仅当“xdm.objectstorage.type”为“S3”时,此配置参数必选。 S3服务所在地址。 127.0.0.1:9000 xdm.objectstorage.s3.ak 仅当“xdm.objectstorage.type”为“S3”时,此配置参数必选。 S3服务的账号。 admin xdm.objectstorage.s3.sk 仅当“xdm.objectstorage.type”为“S3”时,此配置参数必选。 S3服务的密码。 password BUCKET_NAME 仅当“xdm.objectstorage.type”为“S3”时,此配置参数必选。 S3服务使用的桶名。 test_bucket
-
异常处理 问题描述 服务正常启动,但调用任何接口都返回如下错误信息: {
"result": "FAIL",
"timestamp": "2024-12-04 10:33:04",
"error_code": "LIC.60007023",
"error_msg": "No access rights. Please check license config or file.",
"trance_id": null
} 可能原因 此错误信息表示当前SDK未正常运行,无法提供服务。可能存在如下原因: 当前SDK服务的试用时间已到期。 当前SDK服务未配置License。 当前SDK服务配置的License已过期。 当前SDK服务配置License的信息填写不正确。 处理步骤 在容器环境中,调用如下接口,获取容器的ESN。 http://{容器的IP地址}:{SDK服务的端口号}/rdm_{应用的唯一标识}_app/services/v1/license/collect-esn 记录显示结果中的“data”信息。 {
"result": "SUC
CES S",
"data": [
"ESN"
],
"errors": []
} 将1记录的“data”信息提供给运维工程师,获取License文件。 在配置文件(例如“application.properties”)中添加License配置信息。