- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
- 控制台操作指南
-
数据建模引擎用户指南
- 设计态使用指南
- 运行态使用指南
- 流程引擎使用指南
- 数字主线引擎用户指南
- 最佳实践
- 开发指南
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 应用管理
- 运行服务管理
-
数据建模引擎
- 基础数据服务
-
版本服务
- 管理员更新M-V模型数据实例
- 管理员批量更新M-V模型数据实例
- 管理员撤销检出M-V模型数据实例
- 管理员批量撤销检出M-V模型数据实例
- 获取指定M-V模型实例的版本列表
- 获取指定版本的M-V模型实例数据
- 检出M-V模型数据实例
- 批量检出M-V模型数据实例
- 检出并更新M-V模型
- 批量检出并更新M-V模型
- 撤销检出M-V模型数据实例
- 批量撤销检出M-V模型数据实例
- 检入M-V模型数据实例
- 批量检入M-V模型数据实例
- 更新并检入M-V模型数据实例
- 批量更新并检入M-V模型数据实例
- 修订M-V模型数据实例
- 批量修订M-V模型数据实例
- 修订并更新M-V模型数据实例
- 批量修订并更新M-V模型数据实例
- 批量升级M-V模型实例的版本号
- 删除版本对象下最新分支的最新版本实例数据
- 软删除版本对象下最新分支的最新版本实例数据
- 删除最新大版本下的所有小版本
- 批量删除最新大版本下的所有小版本
- 软删除M-V模型实例下最新分支的所有小版本数据
- 批量软删除最新大版本下的所有小版本
- 对比M-V模型实例
- 失效管理
- 业务编码生成器
- 标签管理
- 生命周期管理
- 系统版本
- 多维视图和多维分支
- 关系实体服务
- 树形结构
- 流程引擎
- 应用示例
- 权限和授权项
- 附录
- SDK参考
-
常见问题
- 一般性相关问题
- 计量计费相关问题
-
数据建模引擎相关问题
- 设计态与运行态有什么区别?
- 为什么无法登录应用运行态?
- 为什么用户管理中会有“用户不存在”的用户?
- 为什么登录应用运行态时提示“缺少参数或参数错误”?
- 为什么设置输入型参数时提示安全校验失败?
- 应用发布后,在运行态为什么看不到构建的模型数据?
- 如何验证已设置的用户权限已生效?
- 什么是XDM应用?
- 什么是M-V模型?
- 数据建模引擎支持哪些属性类型?
- 枚举、合法值和参考对象的区别是什么?
- 入图和不入图有什么不同?
- 数据建模引擎支持哪些层级的缓存?
- 如何进行应用同步?
- 可以通过API方式使用应用设计态吗?
- 体验版数据建模引擎和基础版数据建模引擎提供的API有什么不同?
- 如何查看数据建模引擎的版本号?
- 如何避免数据模型互相引用形成环?
- 使用JDK 17版本应用运行态时,服务编排存在哪些约束与限制?
-
数字主线引擎相关问题
- 什么是企业租户和应用租户?
- 创建实体时选择构建表的作用是什么?
- 复杂实体属性太多,创建麻烦怎么办?
- 什么是源端映射和目标端映射?
- 什么是增量字段?
- 关系型数据库映射配置中DelFlag字段的作用是什么?
- 创建数据质量任务时,怎么选不出数据实体?
- 为什么LinkX-F中xDM-F来源的实例数据的最后更新时间显示与xDM-F中不一致
- 什么是入图调度的数据起止时间和数据分片间隔?
- 聚合服务编排中非纯脚本服务选择入参时,提示错误“初始数据实体必填入参为空,请选择必填入参”?
- 发布聚合服务后生成的API如何调用?
- 调用聚合服务时提示“查找不到该企业用户”
- 为什么操作时提示WSF参数校验失败?
- 描述类信息中输入英文双引号导致系统错误提示
- 全量数据服务API相关问题
- 文档下载
- 通用参考
链接复制成功!
搜索服务管理开发指导
涉及的接口
接口名称 |
说明 |
---|---|
https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchservicedefine/create |
创建搜索服务。 |
https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchServiceIndexDefinition/saveList |
添加索引。 |
https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchServColumnController/saveDataServIndexEntityList |
添加服务配置。 |
https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchservicedefine/publishSingle |
发布搜索服务。 |
https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchServ/startEsSync/{serNumber} |
同步搜索服务。 |
步骤1:定义搜索服务
- 准备工作。
在应用运行态中获取定义搜索服务的API信息,具体操作请参见全量数据服务。
- 根据实际业务需求,调用API创建搜索服务。
- 请求示例
POST https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchservicedefine/create { "params": { "createDTO": { "name": "搜索服务示例", "description": "搜索服务示例", "descriptionEn": "Sample", "nameEn": "Sample", "owner": "", "tenantAliasName": "TestDME" }, "tags": [] } }
其中,{Endpoint}表示数据建模引擎所在域名或IP地址,{appID}表示应用ID,“name”、“nameEn”、“description”、“descriptionEn”表示搜索服务的中英文名称和中英文描述。
- 响应示例
{ "result": "SUCCESS", "data": [ { "id": "505115507221864448", "className": "XDMSearchServDefine", "name": "搜索服务示例", "description": "搜索服务示例", "kiaguid": null, "securityLevel": "internal", "master": { "id": "505115507255418880", "creator": "TestAccount2 5547b9adee************8aac057d2c", "modifier": "TestAccount2 5547b9adee************8aac057d2c", "createTime": "2023-05-30T12:28:41.522+0000", "lastUpdateTime": "2023-05-30T12:28:41.522+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "XDMSearchServDefineMaster", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-12-01T11:24:39.000+0000", "lastUpdateTime": "2022-12-01T11:24:39.000+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "XDMSearchServDefineMaster", "servNumber": "SS60466196" }, "branch": { "id": "505115507255418881", "creator": "TestAccount2 5547b9adee************8aac057d2c", "modifier": "TestAccount2 5547b9adee************8aac057d2c", "createTime": "2023-05-30T12:28:41.569+0000", "lastUpdateTime": "2023-05-30T12:28:41.569+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "XDMSearchServDefineBranch", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-12-01T11:24:39.000+0000", "lastUpdateTime": "2022-12-01T11:24:39.000+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "XDMSearchServDefineBranch", "version": "A" }, "latest": true, "latestIteration": true, "versionCode": 1, "iteration": 1, "version": "A", "latestVersion": true, "workingCopy": true, "workingState": { "code": "INWORK", "cnName": "工作中", "enName": "inwork", "alias": "INWORK" }, "checkOutUserName": "TestAccount2 5547b9adee54423cbc05978aac057d2c", "checkOutTime": "2023-05-30T12:28:41.514+0000", "preVersionId": null, "owner": "", "descriptionEn": "Sample", "esindexId": null, "dmentityVersion": null, "dmentityVersionName": null, "step": null, "nameEn": "Sample", "needRefresh": false, "graphId": null, "lifecycleTemplate": null, "lifecycleState": null, "disableFlag": false } ], "errors": [] }
- 请求示例
步骤2:添加索引
- 准备工作。
在应用运行态中获取添加索引的API信息,具体操作请参见全量数据服务。
- 根据实际业务需求,调用API添加索引。
- 请求示例
POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchServiceIndexDefinition/saveList { "params": { "searchServId": "505115507221864448", "searchServName": "搜索服务示例", "indexServColuVOList": [ { "id": null, "indexName": "SampleIndex", "indexDesc": "", "indexType": "TEXT", "operator": null, "inputSeparator": null, "segMethod": "NOWORD", "segOption": "NOTINVOLVED", "searchUsage": true, "keywordUsage": true, "displayUsage": true, "matchType": "FUZZY", "key": "indexDefinition43" } ] } }
其中,{Endpoint}表示数据建模引擎所在域名或IP地址,{appID}表示应用ID,“indexName”、“indexDesc”、“indexType”表示索引名称、描述和类型。
- 响应示例
{ "result": "SUCCESS", "data": [ { "id": "505115594543079424", "rdmExtensionType": "XDMSearchIndexEntity", "className": "XDMSearchIndexEntity", "searchServId": "505115507221864448", "indexName": "SampleIndex", "matchType": { "code": "fuzzy", "cnName": "模糊匹配", "enName": "fuzzy", "alias": "FUZZY" }, "displayUsage": true, "keywordUsage": true, "operator": null, "segOption": { "code": "notInvolved", "cnName": "不涉及", "enName": "notInvolved", "alias": "NOTINVOLVED" }, "indexMaxFieldSize": null, "indexType": { "code": "Text", "cnName": "文本", "enName": "Text", "alias": "TEXT" }, "indexDesc": "", "searchUsage": true, "segMethod": { "code": "noWord", "cnName": "不分词", "enName": "noWord", "alias": "NOWORD" }, "searchServName": "搜索服务示例", "inputSeparator": null, "relationIndexEntityList": null } ], "errors": [] }
- 请求示例
步骤3:添加服务配置
- 准备工作。
在应用运行态中获取添加服务配置的API信息,具体操作请参见全量数据服务。
- 根据实际业务需求,调用API添加服务配置。
- 请求示例
POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchServColumnController/saveDataServIndexEntityList { "params": { "searchServId": "505115507221864448", "searchServIndexEntityVOList": [ { "entityName": "TestData", "entityNameEn": "TestData", "dataServRelationVOList": [ { "attrName": "Code", "attrDesc": null, "searchIndexId": "505115594543079424", "indexType": "TEXT", "dataModelVersionNameEn": "Tenant", "extendAttr": false, "attrType": "STRING", "sortNo": 1 } ] } ] } }
其中,{Endpoint}表示数据建模引擎所在域名或IP地址,{appID}表示应用ID,“searchServIndexEntityVOList”表示服务配置中选中的实体和属性。
- 响应示例
{ "result": "SUCCESS", "data": [], "errors": [] }
- 请求示例
步骤4:发布和验证搜索服务
- 准备工作。
在应用运行态中获取发布搜索服务的API信息,具体操作请参见全量数据服务。
- 完成搜索服务的配置后,调用API发布搜索服务。
- 请求示例
POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchservicedefine/publishSingle { "params": "505115507221864448" }
其中,{Endpoint}表示数据建模引擎所在域名或IP地址,{appID}表示应用ID,“params”表示待发布的搜索服务ID。
- 响应示例
{ "result": "SUCCESS", "data": [], "errors": [] }
- 请求示例
步骤5:同步搜索服务数据
- 准备工作。
在应用运行态中获取同步搜索服务的API信息,具体操作请参见全量数据服务。
- 根据实际业务需求,调用API同步搜索服务数据。
- 请求示例
PUT http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchServ/startEsSync/{serNumber}
其中,{Endpoint}表示数据建模引擎所在域名或IP地址,{appID}表示应用ID,“serNumber”待同步的搜索服务ID。
- 响应示例
{ "result": "SUCCESS", "data": [], "errors": [] }
- 请求示例