华为云用户手册

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 id String 参数解释： 应用ID。 取值范围： 不涉及。 默认取值： 不涉及。 project_id String 参数解释： 项目ID。 取值范围： 只能由英文字母、数字组成，且长度为36个字符。 默认取值： 不涉及。 mark_for_delete Integer 参数解释： 删除标记。 取值范围： 0：未删除 1：删除 默认取值： 不涉及。 create_by String 参数解释： 创建人。 取值范围： 不涉及。 默认取值： 不涉及。 create_time Long 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 update_by String 参数解释： 更新人。 取值范围： 不涉及。 默认取值： 不涉及。 update_time Long 参数解释： 更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 name_cn String 参数解释： 应用的中文名称。 取值范围： 应用名称只能包含中文、英文字母、数字、“_”、“-”，且不能为XDM，最大长度128字符。 默认取值： 不涉及。 name_en String 参数解释： 应用的英文名称。 取值范围： 英文长度128个字符以内，只允许大写字母开头，且不能为XDM，且只包含字母和数字。 默认取值： 不涉及。 desc_cn String 参数解释： 应用的中文描述。 取值范围： 只能包含中文、大小写英文字母、数字、括号、“_”、“-”、空格、标点符号，最大长度1024个字符。 默认取值： 不涉及。 desc_en String 参数解释： 应用的英文描述。 取值范围： 只能包含大小写英文字母、数字、“_”、“-”、空格、标点符号，最大长度1024个字符。 默认取值： 不涉及。 database_type String 参数解释： 应用的数据库类型。 取值范围： 支持MySQL和PostgreSQL。 默认取值： 不涉及。 environment String 参数解释： 运行服务的环境标识。 取值范围： dev：用于开发环境。 sit：用于功能测试环境。 uat：用于用户测试环境。 train：用于培训环境。 beta：用于灰度部署环境。 production：用于生产环境。 默认取值： 不涉及。 versions String 参数解释： 应用责任人。 取值范围： 不涉及。 默认取值： 不涉及。 migrating Boolean 参数解释： 判断是否在迁移中。 取值范围： true:迁移中。 false:未迁移。 默认取值： 不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM 用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 app_name_cn 是 String 参数解释： 应用的中文名称。 约束限制： 不涉及。 取值范围： 应用名称只能包含中文、英文字母、数字、“_”、“-”，且不能为XDM，最大长度128字符。 默认取值： 不涉及。 app_name_en 是 String 参数解释： 应用的英文名称。 约束限制： 不涉及。 取值范围： 英文长度128个字符以内，只允许大写字母开头，且不能为XDM，且只包含字母和数字。 默认取值： 不涉及。 app_desc 否 String 参数解释： 应用的中文描述。 约束限制： 不涉及。 取值范围： 只能包含中文、大小写英文字母、数字、括号、“_”、“-”、空格、标点符号，最大长度1024个字符。 默认取值： 不涉及。 app_desc_en 否 String 参数解释： 应用的中文描述。 约束限制： 不涉及。 取值范围： 只能包含大小写英文字母、数字、“_”、“-”、空格、标点符号，最大长度1024个字符。 默认取值： 不涉及。 operate_type 否 String 参数解释： 操作类型。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 app_env 是 String 参数解释： 环境标识。 约束限制： 不涉及。 取值范围： dev：用于开发环境。 sit：用于功能测试环境。 uat：用于用户测试环境。 train：用于培训环境。 beta：用于灰度部署环境。 production：用于生产环境。 默认取值： 不涉及。 database_type 是 String 参数解释： 数据库类型。 约束限制： 不涉及。 取值范围： 支持MySQL和PostgreSQL。 默认取值： 不涉及。 app_user_list 是 Array of AppUserList objects 参数解释： 应用责任人。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 integration_mode 是 String 参数解释 集成模式。 约束限制： 不涉及。 取值范围： API SDK 默认取值： 不涉及。 app_type 否 String 参数解释： 使用场景。 约束限制： 不涉及。 取值范围： default：标准 lite： 轻量 默认取值： 不涉及。 permission_control 否 String 参数解释： APP权限控制。 约束限制： 不涉及。 取值范围： NONE：关闭权限校验 ALL： 开启所有校验 默认取值： 不涉及。 表4 AppUserList 参数 是否必选 参数类型 描述 id 否 String 参数解释： 用户ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为36个字符。 默认取值： 不涉及。 name 否 String 参数解释： 用户名。 约束限制： 不涉及。 取值范围： 最大长度255个字符。 默认取值： 不涉及。

响应示例 状态码：200 OK { "result" : "SUC CES S", "data" : [ { "id" : "123", "creator" : "test1", "modifier" : "XDM_Developer xxx", "createTime" : "2023-12-04T11:52:48.000+0000", "lastUpdateTime" : "2023-12-06T06:44:32.287+0000", "rdmVersion" : 3, "rdmDeleteFlag" : 0, "rdmExtensionType" : "PersistableModel", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2023-12-01T01:25:21.000+0000", "lastUpdateTime" : "2023-12-01T01:25:21.000+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Tenant", "tenant" : null, "className" : "Tenant", "name" : "basicTenant", "description" : "默认租户", "kiaguid" : null, "securityLevel" : "internal", "nameEn" : null, "code" : "basicTenant", "disableFlag" : false, "dataSource" : "DefaultDataSource" }, "className" : "PersistableModel", "uniqueKey" : "123" } ], "errors" : [ ] }

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/updateByCondition { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "condition" : { "characterSet" : "UTF8", "isNeedTotal" : true, "isPresentAll" : true, "publicData" : "INCLUDE_PUBLIC_DATA", "decrypt" : false, "filter" : { "joiner" : "and", "ignoreStr" : false, "conditions" : [ { "conditionName" : "id", "conditionValues" : [ "2" ], "operator" : "=", "ignoreStr" : false } ] }, "sorts" : [ ] }, "updateDTO" : { "modifier" : "test1", "creator" : "test1", "rdmExtensionType" : "PersistableModel", "uniqueKey" : "条件更新" } } }

响应参数 状态码：200 表10 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of PersistableModelViewDTO objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表11 PersistableModelViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime AnyType 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 uniqueKey String 参数解释： 示例模型中定义的唯一键属性。 取值范围： 不涉及。 默认取值： 不涉及。 表12 TenantViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 code String 参数解释： 租户编码。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 dataSource String 参数解释： 租户使用的数据源名称。 取值范围： 不涉及。 默认取值： 不涉及。 description String 参数解释： 描述信息。 取值范围： 不涉及。 默认取值： 不涉及。 disableFlag Boolean 参数解释： 失效标识。 取值范围： true：失效。 false：未失效。 默认取值： false。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 kiaguid String 参数解释： KIA密级。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 securityLevel String 参数解释： 安全密级。 取值范围： INTERNAL：内部公开。 SECRET：秘密。 CONFIDENTIAL：机密。 TOP_SECRET：绝密。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/updateByCondition 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。 默认取值： 不涉及。

响应示例 状态码：200 OK { "page_num" : null, "page_size" : null, "total_size" : null, "total_pages" : null, "result" : [ { "project_id" : "", "region_id" : "", "env_id" : "", "env_name" : "", "env_status" : "", "env_app_link_status" : null, "env_app_link_status_msg" : null, "endpoint" : null, "job_id" : null, "env_conf_info" : "", "env_app_link_id" : null, "app_id" : null, "app_version" : null, "app_name_en" : null, "app_name_cn" : null, "enabled" : "", "expire_time" : null, "last_deploy_time" : null, "deploy_user_id" : null, "charging_mode" : "", "create_time" : null, "resource_id" : "", "deployable" : "", "uninstallable" : "" } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 page_num Integer 参数解释： 分页查询的页数。 取值范围： 不涉及。 默认取值： 1。 page_size Integer 参数解释： 分页查询时，每页最多展示的记录数。 取值范围： 不涉及。 默认取值： 10。 total_size Integer 参数解释： 总共条数。 取值范围： 不涉及。 默认取值： 不涉及。 total_pages Integer 参数解释： 总共页数。 取值范围： 不涉及。 默认取值： 不涉及。 result Array of result objects 参数解释： 运行服务详情。 取值范围： 不涉及。 默认取值： 不涉及。 表4 result 参数 参数类型 描述 project_id String 参数解释： 项目ID。 取值范围： 只能由英文字母、数字组成，且长度为36个字符。 默认取值： 不涉及。 region_id String 参数解释： 区域ID。 取值范围： 不涉及。 默认取值： 不涉及。 env_id String 参数解释： 运行服务的ID。 取值范围： 不涉及。 默认取值： 不涉及。 env_name String 参数解释： 运行服务的名称。 取值范围： 不涉及。 默认取值： 不涉及。 env_status String 参数解释： 运行服务的状态。 取值范围： 不涉及。 默认取值： 不涉及。 env_type String 参数解释： 服务的类型。 取值范围： 不涉及。 默认取值： 不涉及。 env_app_link_status String 参数解释： 运行服务与应用间的状态。 取值范围： 不涉及。 默认取值： 不涉及。 env_app_link_status_msg String 参数解释： 运行服务与应用间的状态信息。 取值范围： 不涉及。 默认取值： 不涉及。 endpoint String 参数解释： 访问方式。 取值范围： 不涉及。 默认取值： 不涉及。 job_id String 参数解释： 创建运行服务的jobId。 取值范围： 不涉及。 默认取值： 不涉及。 env_conf_info String 参数解释： 运行服务的配置信息。 取值范围： 不涉及。 默认取值： 不涉及。 env_app_link_id String 参数解释： 环境应用关联ID。 取值范围： 不涉及。 默认取值： 不涉及。 app_id String 参数解释： 部署的应用ID。 取值范围： 不涉及。 默认取值： 不涉及。 app_version String 参数解释： 部署的应用版本。 取值范围： 不涉及。 默认取值： 不涉及。 app_name_en String 参数解释： 部署应用的英文名称。 取值范围： 不涉及。 默认取值： 不涉及。 app_name_cn String 参数解释： 部署应用的中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 app_environment String 参数解释： 应用环境。 取值范围： 不涉及。 默认取值： 不涉及。 enabled Boolean 参数解释： 应用是否可用。 取值范围： 不涉及。 默认取值： 不涉及。 expire_time Long 参数解释： 运行服务的过期时间。 取值范围： 不涉及。 默认取值： 不涉及。 last_deploy_time Long 参数解释： 最后部署时间。 取值范围： 不涉及。 默认取值： 不涉及。 deploy_user_id String 参数解释： 上次部署应用的IAM用户ID。 取值范围： 不涉及。 默认取值： 不涉及。 charging_mode String 参数解释： 计费模式。 取值范围： 不涉及。 默认取值： 不涉及。 create_time Long 参数解释： 运行服务的创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 resource_id String 参数解释： 绑定主资源ID。 取值范围： 不涉及。 默认取值： 不涉及。 resource_spec_code String 参数解释： 资源规格编码。 取值范围： 不涉及。 默认取值： 不涉及。 org_code String 参数解释： 组织编码。 取值范围： 不涉及。 默认取值： 不涉及。 org_name String 参数解释： 组织名称。 取值范围： 不涉及。 默认取值： 不涉及。 app_login_url String 参数解释： 应用登录首页。 取值范围： 不涉及。 默认取值： 不涉及。 deployable Boolean 参数解释： 是否支持部署。 取值范围： 不涉及。 默认取值： 不涉及。 app_create_time String 参数解释： 应用创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 database_type String 参数解释： 数据库类型。 取值范围： 只是Mysql和Postgresql。 默认取值： 不涉及。 uninstallable Boolean 参数解释： 是否支持卸载。 取值范围： 不涉及。 默认取值： 不涉及。 vpc_id String 参数解释： 虚拟私有云ID。 取值范围： 不涉及。 默认取值： 不涉及。 enterprise_project_id String 参数解释： 企业项目ID。 取值范围： 不涉及。 默认取值： 不涉及。 read_write_user_limit String 参数解释： 读写用户数量。 取值范围： 不涉及。 默认取值： 不涉及。 runtime_instance_limit String 参数解释： 运行服务节点数量。 取值范围： 不涉及。 默认取值： 不涉及。 private_ip_id String 参数解释： 内网ID。 取值范围： 不涉及。 默认取值： 不涉及。 private_ip String 参数解释： 内网IP。 取值范围： 不涉及。 默认取值： 不涉及。 security_group_id String 参数解释： 安全组ID。 取值范围： 不涉及。 默认取值： 不涉及。 workflow_used_status String 参数解释： 流程引擎开启状态。 取值范围： 不涉及。 默认取值： 不涉及。 experiences_deployable String 参数解释： 是否可部署体验版。 取值范围： 不涉及。 默认取值： 不涉及。 change_able String 参数解释： 是否可变更。 取值范围： 不涉及。 默认取值： 不涉及。 delete_able String 参数解释： 是否删除。 取值范围： 不涉及。 默认取值： 不涉及。 grace_time String 参数解释： 宽限期结束时间。 取值范围： 不涉及。 默认取值： 不涉及。 release_time String 参数解释： 资源释放时间。 取值范围： 不涉及。 默认取值： 不涉及。 frozen_time String 参数解释： 冻结时间。 取值范围： 不涉及。 默认取值： 不涉及。 linkx_quota_resp String 参数解释： LinkX-F配额详情。 取值范围： 不涉及。 默认取值： 不涉及。 structured_data_package_limit String 参数解释： 结构化数据增量包。 取值范围： 不涉及。 默认取值： 不涉及。 file_data_package_limit String 参数解释： 文件数据增量包。 取值范围： 不涉及。 默认取值： 不涉及。 hostname String 参数解释： 默认 域名 。 取值范围： 不涉及。 custom_hostname String 参数解释： 用户自定义域名。 取值范围： 不涉及。 默认取值： 不涉及。 public_ip String 参数解释： 公网IP。 取值范围： 不涉及。 默认取值： 不涉及。 access_control_type String 参数解释： 访问控制类型。 取值范围： 不涉及。 默认取值： 不涉及。 hostname_waf_status String 参数解释： 默认域名WAF防护状态。 取值范围： 不涉及。 默认取值： 不涉及。 custom_hostname_waf_status String 参数解释： 自定义域名WAF防护状态。 取值范围： 不涉及。 默认取值： 不涉及。 control_custom_ips String 参数解释： 访问控制IP列表。 取值范围： 不涉及。 默认取值： 不涉及。 internal_ip String 参数解释： 内网地址。 取值范围： 不涉及。 默认取值： 不涉及。 internal_ip_status String 参数解释： 内网访问开启状态。 取值范围： 不涉及。 默认取值： 不涉及。 custom_hostname_effective_status String 参数解释： 客户自定义域名是否生效。 取值范围： 0:未生效，1:已生效。 默认取值： 不涉及。

URI GET /v1/{project_id}/envs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为[1-36]个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 page_num 否 Integer 参数解释： 分页查询的页数。 取值范围： 不涉及。 默认取值： 不涉及。 page_size 否 Integer 参数解释： 分页查询时，每页最多展示的记录数。 取值范围： 不涉及。 默认取值： 不涉及。 env_types 否 String 参数解释： 服务的类型。 取值范围： STUDIO：iDME设计服务。 CLOUD_BASIC：部署在公有云上的基础版数据建模引擎。 CLOUD_BASIC_LITE：部署在公有云上的基础版-Lite数据建模引擎。 CLOUD_TRIAL：部署在公有云上的体验版数据建模引擎。 EDGE_BASIC：部署在边缘云上的基础版数据建模引擎。 CLOUD_LINKX：部署在公有云上的基础版数字主线引擎。 CLOUD_LINKX_LITE：部署在公有云上的基础版-Lite数字主线引擎。 EDGE_LINKX：部署在边缘云上的基础版数字主线引擎。 默认取值： 不涉及。

响应示例 状态码：200 OK { "result": [ { "id": "", "project_id": "", "mark_for_delete": 0, "create_by": "", "create_time": 1673474220000, "update_by": "", "update_time": 1682984766000, "name_cn": "", "name_en": "", "desc_cn": "", "desc_en": "", "database_type": "", "environment": "", “migrating_status”:"" "owners": [ "op_svc_idme_container1", "dme-console" ] } ], "page_num": 1, "page_size": 15, "total_size": 13, "total_pages": 1 }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 page_num Integer 参数解释： 分页查询时，每页最多展示的记录数。 取值范围： 不涉及。 默认取值： 1。 page_size Integer 参数解释： 分页查询的页数。 取值范围： 不涉及。 默认取值： 10。 total_size Integer 参数解释： 总共条数。 取值范围： 不涉及。 默认取值： 不涉及。 total_pages Integer 参数解释： 总页数。 取值范围： 不涉及。 默认取值： 不涉及。 result Array of result objects 参数解释： 应用详情。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 result 参数 参数类型 描述 id String 参数解释： 应用ID。 取值范围： 不涉及。 默认取值： 不涉及。 project_id String 参数解释： 项目ID。 取值范围： 只能由英文字母、数字组成，且长度为36个字符。 默认取值： 不涉及。 app_type String 参数解释： 使用场景。 约束限制： 不涉及。 取值范围： default：标准 lite： 轻量 默认取值： 不涉及。 permission_control String 参数解释： APP权限控制。 约束限制： 不涉及。 取值范围： NONE：关闭权限校验 ALL： 开启所有校验 默认取值： 不涉及。 mark_for_delete Integer 参数解释： 删除标记。 取值范围： 不涉及。 默认取值： 不涉及。 create_by String 参数解释： 创建人。 取值范围： 不涉及。 默认取值： 不涉及。 create_time Long 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 update_by String 参数解释： 更新人。 取值范围： 不涉及。 默认取值： 不涉及。 update_time Long 参数解释： 更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 name_cn String 参数解释： 应用的中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 name_en String 参数解释： 应用的英文名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 desc_cn String 参数解释： 应用的中文描述。 取值范围： 不涉及。 默认取值： 不涉及。 desc_en String 参数解释： 应用的英文描述。 取值范围： 不涉及。 默认取值： 不涉及。 database_type String 参数解释： 应用的数据库类型。 取值范围： 不涉及。 默认取值： 不涉及。 environment String 参数解释： 运行服务的环境标识。 取值范围： 不涉及。 默认取值： 不涉及。 owners Array of strings 参数解释： 应用责任人。 取值范围： 不涉及。 默认取值： 不涉及。

URI GET /v1/{project_id}/apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为[1-36]个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 page_num 否 Integer 参数解释： 分页查询的页数。 取值范围： 不涉及。 默认取值： 不涉及。 page_size 否 Integer 参数解释： 分页查询时，每页最多展示的记录数。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /v1/{project_id}/{service_type}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为[1-36]个字符。 默认取值： 不涉及。 service_type 是 String 参数解释： iDME服务的类型。 约束限制： 不涉及。 取值范围： STUDIO：设计态服务。 默认取值： 不涉及。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code Integer 参数解释： 响应状态码。 取值范围： 不涉及。 默认取值： 不涉及。 message String 参数解释： 响应信息。 取值范围： 不涉及。 默认取值： 不涉及。 job_id String 参数解释： 任务ID。 取值范围： 不涉及。 默认取值： 不涉及。 product_name String 参数解释： 产品名称。 取值范围： 不涉及。 默认取值： 不涉及。 job_ids Array of strings 参数解释： 任务ID列表。 取值范围： 不涉及。 默认取值： 不涉及。 order_ids Array of strings 参数解释： 订单ID列表。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/StructuredDocableModel/structured-doc/documents/query { "params" : { "instance_id" : "1" } }

响应示例 状态码：200 OK { "result" : "SUCCESS", "data" : [ { "creator" : "XDM_Developer 93172bbfd0f64437956d4c9de9345386", "createTime" : "2025-01-15T06:28:59.147+0000", "lastUpdateTime" : "2025-01-15T06:28:59.147+0000", "rdmVersion" : 3, "rdmDeleteFlag" : 0, "rdmExtensionType" : "StructuredDoc", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-11-13T08:27:59.903+0000", "lastUpdateTime" : "2024-11-13T08:27:59.903+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Tenant", "tenant" : null, "className" : "Tenant", "name" : "basicTenant", "description" : "默认租户", "kiaguid" : null, "securityLevel" : "internal", "nameEn" : null, "code" : "basicTenant", "disableFlag" : false, "dataSource" : "DefaultDataSource" }, "className" : "StructuredDoc", "clazz" : "StructuredDoc", "id" : "721008152111222784", "document_id" : "19619ac0-22ee-405a-bf35-53673efa3267", "title" : "myTilte2", "type" : "pageDocument", "template_id" : null, "organization_id" : "65cd6c5df4c84bdeb50dbfc7136cab7c", "wiki_id" : "a962e2d821c44bfdb65d33aa429c930uatwiki", "parent_document_id" : "720941361796222976", "instance_id" : "1", "model_name" : "StructuredDocableModel", "create_user_id" : "93172bbfd0f64437956d4c9de9345386", "modifier" : "XDM_Developer 93172bbfd0f64437956d4c9de9345386" } ], "errors" : [ ] }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of StructuredDocView objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表6 StructuredDocView 参数 参数类型 描述 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识，参数值为0或1。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 不涉及。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 clazz String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 document_id String 参数解释： kooPage文档ID。 取值范围： 不涉及。 默认取值： 不涉及。 title String 参数解释： 文档标题。 取值范围： 不涉及。 默认取值： 不涉及。 type String 参数解释： 文档类型。 取值范围： directory：目录。 pageDocument：Page文档。 boardDocument：Board文档。 mindDocument：Mind文档。 drawDocument：Draw文档。 默认取值： 不涉及。 template_id String 参数解释： 模板ID。 取值范围： 不涉及。 默认取值： 不涉及。 organization_id String 参数解释： 团队ID。 取值范围： 不涉及。 默认取值： 不涉及。 wiki_id String 参数解释： 知识库ID。 取值范围： 不涉及。 默认取值： 不涉及。 parent_document_id String 参数解释： 父文档ID。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id String 参数解释： 实例ID。 取值范围： 不涉及。 默认取值： 不涉及。 model_name String 参数解释： 模型名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 create_user_id String 参数解释： 创建者ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 表7 TenantViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 code String 参数解释： 租户编码。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 dataSource String 参数解释： 租户使用的数据源名称。 取值范围： 不涉及。 默认取值： 不涉及。 description String 参数解释： 描述信息。 取值范围： 不涉及。 默认取值： 不涉及。 disableFlag Boolean 参数解释： 失效标识。 取值范围： true：失效。 false：未失效。 默认取值： false。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 kiaguid String 参数解释： KIA密级。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 securityLevel String 参数解释： 安全密级。 取值范围： INTERNAL：内部公开。 SECRET：秘密。 CONFIDENTIAL：机密。 TOP_SECRET：绝密。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 QueryDocParamDto object 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 QueryDocParamDto 参数 是否必选 参数类型 描述 instance_id 否 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 type 否 String 参数解释： 文档类型。 约束限制： 不涉及。 取值范围： directory：目录。 pageDocument：Page文档。 boardDocument：Board文档。 mindDocument：Mind文档。 drawDocument：Draw文档。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/documents/query 表1 路径参数 参数 是否必选 参数类型 描述 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。 默认取值： 不涉及。 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。

响应参数 状态码：200 表9 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of PersistableModelListViewDTO objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表10 PersistableModelListViewDTO 参数 参数类型 描述 aclEntry String 参数解释： 访问控制列表。 取值范围： 不涉及。 默认取值： 不涉及。 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 clsAttrs Array of objects 参数解释： 分类属性。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 disableFlag Boolean 参数解释： 失效标识。 取值范围： true：失效。 false：未失效。 默认取值： 不涉及。 folder ObjectReferenceViewDTO object 参数解释： 文件夹。 取值范围： 不涉及。 默认取值： 不涉及。 fullPath String 参数解释： 用于存储当前节点全路径。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 leafFlag Boolean 参数解释： 是否为叶子节点。 取值范围： true：是叶子节点。 false：不是叶子节点。 默认取值： false。 lifecycleState ObjectReferenceViewDTO object 参数解释： 状态 取值范围： 不涉及。 默认取值： 不涉及。 lifecycleTemplate ObjectReferenceViewDTO object 参数解释： 生命周期模板。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 更新者。 取值范围： 不涉及。 默认取值： 不涉及。 owner String 参数解释： 拥有者。 取值范围： 不涉及。 默认取值： 不涉及。 parentNode ObjectReferenceViewDTO object 参数解释： 父节点。 取值范围： 不涉及。 默认取值： 不涉及。 rawFullPath String 参数解释： 用于存储当前节点原始全路径。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 rootNode ObjectReferenceViewDTO object 参数解释： 根节点。 取值范围： 不涉及。 默认取值： 不涉及。 tenant ObjectReferenceViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 uniqueKey String 参数解释： 示例模型的唯一键约束属性。 取值范围： 不涉及。 默认取值： 不涉及。 表11 ObjectReferenceViewDTO 参数 参数类型 描述 clazz String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/list/10/1 { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "characterSet" : "UTF8", "isNeedTotal" : true, "isPresentAll" : true, "publicData" : "INCLUDE_PUBLIC_DATA", "decrypt" : false, "filter" : { "joiner" : "and", "ignoreStr" : false, "conditions" : [ { "conditionName" : "rdmExtensionType", "conditionValues" : [ "PersistableModel" ], "operator" : "=", "ignoreStr" : false } ] }, "sorts" : [ ] } }

响应示例 状态码：200 OK { "result" : "SUCCESS", "data" : [ { "aclEntry" : "AclEntry", "className" : "PersistableModel", "clsAttrs" : [ ], "createTime" : "2023-09-27T06:18:03.000+0000", "creator" : "test1", "disableFlag" : false, "folder" : { "clazz" : "PersistableModel", "id" : "548451844855177200" }, "fullPath" : "/*/*/**", "id" : "548451844855177200", "lastUpdateTime" : "2023-09-27T06:18:03.000+0000", "leafFlag" : false, "lifecycleState" : { "clazz" : "PersistableModel", "id" : "548451844855177200" }, "lifecycleTemplate" : { "clazz" : "PersistableModel", "id" : "548451844855177200" }, "modifier" : "test1", "owner" : "test1", "parentNode" : { "clazz" : "PersistableModel", "id" : "548451844855177200" }, "rawFullPath" : "/**/**", "rdmDeleteFlag" : 0, "rdmExtensionType" : "PersistableModel", "rdmVersion" : 1, "rootNode" : { "clazz" : "PersistableModel", "id" : "548451844855177200" }, "tenant" : { "clazz" : "PersistableModel", "id" : "548451844855177200" }, "uniqueKey" : "id" } ], "errors" : [ ] }

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/list/{pageSizePath}/{curPagePath} 表1 路径参数 参数 是否必选 参数类型 描述 pageSizePath 是 Integer 参数解释： 分页大小（路径参数）。 约束限制： 不涉及。 取值范围： 1-1000。 默认取值： 不涉及。 curPagePath 是 Integer 参数解释： 当前页数（路径参数）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 1。 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 curPage 否 Integer 参数解释： 当前页。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 1。 endIndex 否 Integer 参数解释： 结束索引。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 0。 maxPageSize 否 Integer 参数解释： 最大分页数。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 1000。 pageSize 否 Integer 参数解释： 每页大小。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 1000。 startIndex 否 Integer 参数解释： 起始索引。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 0。 totalPages 否 Integer 参数解释： 总页数。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 0。 totalRows 否 Integer 参数解释： 总行数。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 0。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 PersistObjectIdsDTO object 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 PersistObjectIdsDTO 参数 是否必选 参数类型 描述 ids 是 Array of strings 参数解释： 数据实例 ID列表。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of integers 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 DELETE https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/StructuredDocableModel/structured-doc/share-doc/batch { "params" : { "ids" : [ "721366695490363392" ] } }

URI DELETE /rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/share-doc/batch 表1 路径参数 参数 是否必选 参数类型 描述 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。 默认取值： 不涉及。 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/deleteByCondition { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "condition" : { "characterSet" : "UTF8", "isNeedTotal" : true, "isPresentAll" : true, "publicData" : "INCLUDE_PUBLIC_DATA", "decrypt" : false, "filter" : { "joiner" : "and", "ignoreStr" : false, "conditions" : [ { "conditionName" : "id", "conditionValues" : [ "666" ], "operator" : "=", "ignoreStr" : false } ] }, "sorts" : [ ] }, "modifier" : "test1" } }

响应参数 状态码：200 表9 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of longs 参数解释： 请求操作数据数量。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/deleteByCondition 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。 默认取值： 不涉及。