
# 数据建模引擎运行SDK通用配置
 #### 公共信息配置
| 配置参数                              | 是否必选                                                                                                                                                                    | 参数说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | 示例                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| TENANT_ID                         | 是                                                                                                                                                                       | 应用ID，即当前部署应用的ID。 您可以在应用设计态的"应用中心 \> 应用发布"页面获取，详情请参见[应用发布](https://support.huaweicloud.com/usermanual-idme/idme_usermanual_0085.html)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | 123456                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| TENANT_DOMAIN_ID                  | 仅[数据建模引擎运行SDK资源规划](https://support.huaweicloud.com/sdkreference-idme/idme_sdkreference_0008.html#ZH-CN_TOPIC_0000002101358320__section15530131311115)中包含IAM资源时，此配置参数必选。 | 当前IAM的租户ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | 123456                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| APP_NAME                          | 是                                                                                                                                                                       | 应用名称，即当前部署应用的英文名称。 您可以在应用设计态的"应用中心 \> 应用发布"页面获取，详情请参见[应用发布](https://support.huaweicloud.com/usermanual-idme/idme_usermanual_0085.html)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | TestApp                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| APP_IDENTIFIER                    | 是                                                                                                                                                                       | 应用的唯一标识。 - 于2023年06月01日之前创建的应用，其唯一标识为该应用的名称。  - 于2023年06月01日之后创建的应用，其唯一标识为该应用的ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | 123456                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| PAAS_APP_NAME                     | 是                                                                                                                                                                       | 应用英文名称小写。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | testapp                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| xdm.application.sub-app-id        | 是                                                                                                                                                                       | 应用运行态的应用英文名称。 格式为：rdm_*{**应用英文名称小写**}*_app                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | rdm_testapp_app                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| server.ssl.enabled                | 是                                                                                                                                                                       | 设置是否开启SSL认证。 - true：开启SSL认证。  - false：关闭SSL认证，默认为false。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| olc.config.path                   | 是                                                                                                                                                                       | OLC（Overload Control，过载控制）的配置路径，存放在SDK ZIP包的/lib目录下，即"{解压缩SDK后的所在路径}/olc"路径。 如何获取SDK请参见[获取数据建模引擎SDK](https://support.huaweicloud.com/sdkreference-idme/idme_sdkreference_0009.html)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | /opt/cloud/olc                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| DEPLOY_VERSION                    | 是                                                                                                                                                                       | 表示应用已发布的版本。即获取数据建模引擎运行SDK包时，对应应用发布任务的版本号。 格式为：*{**应用的唯一标识**}* _*{* ***版本号**}* 如何查看版本号请参见[查看应用详情](https://support.huaweicloud.com/usermanual-idme/idme_usermanual_0085.html)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | 123456_1736504787375                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| xdm.delegate.bean.inject          | 否                                                                                                                                                                       | 设置是否注册Delegate相关Bean。 - true：注册Delegate相关Bean。  - false：不注册Delegate相关Bean，默认为false。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| server.servlet.context-path       | 否                                                                                                                                                                       | Spring访问HTTP的路径，默认为"/rdm_general_app/services/"。 推荐格式：/rdm_*{**应用的唯一标识**}*_app/services/ 完成配置此参数并启动SDK后，应用运行态访问路径为：**http://*{部署服务器的IP地址}:{部署服务器的端口号}* /rdm_*{应用的唯一标识}*_app/services/index.html**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | /rdm_123456_app/services/                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| server.port                       | 否                                                                                                                                                                       | 启动Spring时需要使用的端口号，默认为8003。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | 8003                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| xdm.runtime.tenant.info           | 如果您希望后续可通过可视化页面访问应用运行态，此配置参数必选。                                                                                                                                         | 设置需要启动应用运行态的具体应用信息。其格式如下： ``` { "owner": "{IAM的租户ID}", "shortName": "{应用名称}", "codeRepository": null, "dbConn": null, "dbReadOnlyConn": null, "hisDeployUnit": null, "databaseType": "{数据库类型}", "aliasName": "SITAutotest", "hisAppId": null, "tps": 1000, "qps": 1000, "operationTime": null, "dAMIntegrated": false, "xDMHosted": false, "appNameEn": "{应用的英文名称}", "certifiedDataSourceNumber": "1", "integrationMode": "API", "domain": null, "appEnvInfo": "{环境标识}", "metadataSynchronization": false, "codeDownloadPath": "", "jarDownloadPath": "", "appStatus": 1, "domainId": "{IAM的租户ID}", "domainName": null, "identifier": "{应用的唯一标识}", "cloudDragonProjectId": null, "isSyncAstroPro": false, "tenantId": null, "publicKey": null, "privateKey": null, "markForDelete": false, "name": "{应用的中文名称}", "nameEn": "{应用的英文名称}", "description": "{应用描述}", "descriptionEn": "", "id": "{应用ID}", "creator": "{IAM的用户名} {IAM的用户ID}", "createTime": "2023-04-06 11:59:54", "modifier": "{IAM的用户名} {IAM的用户ID}", "lastModifiedTime": "2024-03-27 09:36:34" } ``` | ``` { "owner": "userid", "shortName": "TestApp", "codeRepository": null, "dbConn": null, "dbReadOnlyConn": null, "hisDeployUnit": null, "databaseType": "postgresql", "aliasName": "TestApp", "hisAppId": null, "tps": 1000, "qps": 1000, "operationTime": null, "dAMIntegrated": false, "xDMHosted": false, "appNameEn": "TestApp", "certifiedDataSourceNumber": "1", "integrationMode": "API", "domain": null, "appEnvInfo": "sit", "metadataSynchronization": false, "codeDownloadPath": "", "jarDownloadPath": "", "appStatus": 1, "domainId": "domainId", "domainName": null, "identifier": "TestApp", "cloudDragonProjectId": null, "isSyncAstroPro": false, "tenantId": null, "publicKey": null, "privateKey": null, "markForDelete": false, "name": "TestApp", "nameEn": "TestApp", "description": "用于SIT环境运行态的验证。", "descriptionEn": "", "id": "appid", "creator": "username userid", "createTime": "2023-04-06 11:59:54", "modifier": "username userid", "lastModifiedTime": "2024-03-27 09:36:34" } ``` |
| xdm.runtime.java-compile.lib-path | 是                                                                                                                                                                       | Java服务编排的编译路径。 配置格式为：{解压缩SDK后的所在路径}/lib 如何获取SDK请参见[获取数据建模引擎SDK](https://support.huaweicloud.com/sdkreference-idme/idme_sdkreference_0009.html)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | /opt/cloud/lib                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| PROJECT_ID                        | 访问ECS、IAM等华为云云服务时，此配置参数必选。                                                                                                                                              | 项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-idme/idme_api_0024.html)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | projectid                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| RES_AK                            | 访问ECS、IAM等华为云云服务时，此配置参数必选。                                                                                                                                              | IAM的Access Key，用于作为访问其他华为云服务的凭证。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | testak                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| RES_SK                            | 访问ECS、IAM等华为云云服务时，此配置参数必选。                                                                                                                                              | IAM的Secret Access Key，用于作为访问其他华为云服务的凭证。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | testsk                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| APIG_DEFAULT_GROUP_HOST           | 访问某全量数据服务API详情时，此配置项必选。                                                                                                                                                 | 用于构建"数据服务管理 \> 全量数据服务"页面中各接口的具体URL地址。 格式为：http://***{部署服务器的IP地址}*** :***{部署服务器的端口号}***                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | http://127.0.0.1:8003                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| xdm.license.temp-deploy.enable    | 否                                                                                                                                                                       | 是否开启临时部署。 - true：开启临时部署。在容器部署场景下，如果机器信息与许可证不匹配，仍可临时启动服务。单个许可证文件允许的临时部署时长不得超过8天。  - false：关闭临时部署，默认为false。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | true                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| DISABLE_CSRF                      | 否                                                                                                                                                                       | 是否关闭CSRF校验。 - true：关闭CSRF校验。  - false：开启CSRF校验，默认为false。开启时，系统会校验请求头中是否包含"X-Auth-Token"。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
   
 #### 数据库配置
以下为MySQL、PostgreSQL和GaussDB类型数据库所需的配置项。不同数据库类型有特定的配置要求，请根据实际使用的数据库类型进行设置。其中：
- MySQL类型数据库： 推荐将Schema的编码字符集设置为**utf8mb4** ，排序规则设置为**utf8mb4_general_ci**。如果使用其他字符集，可能会存在语法不兼容问题。
  
- GaussDB类型数据库： 数据库兼容类型需设置为PostgreSQL。如果使用其他兼容类型，可能会存在语法不兼容问题。
  
配置参数详情如下：
| 配置参数                              | 是否必选                                | 参数说明                                                                                                                                                                                                                                                                                                                                                                  | MySQL示例   | PostgreSQL示例                                                                                    | GaussDB示例                                                                                                                                 |
|:---|:---|:---|:---|:---|:---|
| RDS_IP                            | 是                                   | 数据库服务地址。                                                                                                                                                                                                                                                                                                                                                              | 127.0.0.1 | 127.0.0.1                                                                                       | 127.0.0.1                                                                                                                                 |
| RDS_PORT                          | 是                                   | 数据库端口。                                                                                                                                                                                                                                                                                                                                                                | 3306      | 5432                                                                                            | 8000                                                                                                                                      |
| RDS_TYPE                          | 是                                   | 数据库类型。                                                                                                                                                                                                                                                                                                                                                                | mysql     | postgresql                                                                                      | gaussdb                                                                                                                                   |
| RDS_NAME                          | 是                                   | 数据库用户名。                                                                                                                                                                                                                                                                                                                                                               | admin     | postgres                                                                                        | postgres                                                                                                                                  |
| RDS_PASSWORD                      | 是                                   | 数据库密码。                                                                                                                                                                                                                                                                                                                                                                | admin     | admin                                                                                           | admin                                                                                                                                     |
| RDS_DATABASE                      | 是                                   | 数据库schema名称。                                                                                                                                                                                                                                                                                                                                                          | test      | test                                                                                            | test                                                                                                                                      |
| spring.datasource.url             | 仅为PostgreSQL或GaussDB类型数据库时，此配置参数必选。 | 数据库连接串格式。                                                                                                                                                                                                                                                                                                                                                             | -         | jdbc:postgresql://${RDS_IP}:${RDS_PORT}/${RDS_DATABASE}?sslmode=require\&stringtype=unspecified | jdbc:opengauss://${RDS_IP}:${RDS_PORT}/${RDS_DATABASE}?stringtype=unspecified\&sslmode=require\&batchMode=off\&reWriteBatchedInserts=true |
| xdm.runtime.hibernate.dialect     | 仅为PostgreSQL或GaussDB类型数据库时，此配置参数必选。 | Hibernate数据库方言。                                                                                                                                                                                                                                                                                                                                                       | -         | com.huawei.it.rdm.configuration.XdmPostgresqlDialect                                            | com.huawei.it.rdm.configuration.XdmGaussDbDialect                                                                                         |
| spring.datasource.driverClassName | 仅为PostgreSQL或GaussDB类型数据库时，此配置参数必选。 | 数据库驱动名称。                                                                                                                                                                                                                                                                                                                                                              | -         | org.postgresql.Driver                                                                           | com.huawei.opengauss.jdbc.Driver                                                                                                          |
| xdm.runtime.db-type               | 仅为PostgreSQL或GaussDB类型数据库时，此配置参数必选。 | 数据库类型。                                                                                                                                                                                                                                                                                                                                                                | -         | postgresql                                                                                      | gaussdb                                                                                                                                   |
| hibernate.auto_quote_keyword      | 仅为GaussDB类型数据库时，此配置参数必选。            | 是否自动给关键字加双引号（"）。 - false：不自动给关键字加双引号（"）。  - true：自动给关键字加双引号（"）。   | false     | false                                                                                           | true                                                                                                                                      |
   
#### Redis配置
Redis支持单点模式和集群模式，请根据实际Redis服务类型进行配置。
| 配置参数                | 是否必选                              | 参数说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | 示例                            |
|:---|:---|:---|:---|
| REDIS_TYPE          | 是                                 | Redis服务类型，支持如下两种模式： - SINGLE：单点模式。  - CLUSTER：集群模式。   设置Redis服务类型后，您需要进一步设置。 | SINGLE                        |
| REDIS_HOST          | 仅当"REDIS_TYPE"为"SINGLE"时，此配置项必选。  | 单点模式下的Redis地址。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | 127.0.0.1                     |
| REDIS_PORT          | 仅当"REDIS_TYPE"为"SINGLE"时，此配置项必选。  | 单点模式下的Redis端口。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | 6379                          |
| REDIS_CLUSTER_NODES | 仅当"REDIS_TYPE"为"CLUSTER"时，此配置项必选。 | 集群模式下的Redis地址。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | 127.0.0.1:6379,127.0.0.1:6380 |
| REDIS_PASSWORD      | 是                                 | Redis密码。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | admin                         |
   
