华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM 用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 params 否 Array of VersionModel objects 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表4 VersionModel 参数 是否必选 参数类型 描述 branch 否 VersionModelBranch object 参数解释: 分支对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 checkOutTime 否 String 参数解释: 检出时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 checkOutUserName 否 String 参数解释: 检出用户名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 createTime 否 String 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 creator 否 String 参数解释: 创建者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 description 否 String 参数解释: 描述信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 id 否 String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 kiaguid 否 String 参数解释: 关键信息资产ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 lastUpdateTime 否 String 参数解释: 最后更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 master 否 VersionModelMaster object 参数解释: 主对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 modifier 否 String 参数解释: 更新者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 name 否 String 参数解释: 中文名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 needSetNullAttrs 否 Array of strings 参数解释: 设置NULL值的属性名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 rdmExtensionType 否 String 参数解释: 扩展类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 securityLevel 否 String 参数解释: 安全密级。 约束限制: 不涉及。 取值范围: INTERNAL:内部公开。 SECRET:秘密。 CONFIDENTIAL:机密。 TOP_SECRET:绝密。 默认取值: 不涉及。 表5 VersionModelBranch 参数 是否必选 参数类型 描述 createTime 否 String 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 creator 否 String 参数解释: 创建者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 id 否 String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 lastUpdateTime 否 String 参数解释: 最后更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 modifier 否 String 参数解释: 更新者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 needSetNullAttrs 否 Array of strings 参数解释: 设置NULL值的属性名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 rdmExtensionType 否 String 参数解释: 扩展类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表6 VersionModelMaster 参数 是否必选 参数类型 描述 createTime 否 String 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 creator 否 String 参数解释: 创建者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 id 是 String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 lastUpdateTime 否 String 参数解释: 最后更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 modifier 否 String 参数解释: 更新者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 needSetNullAttrs 否 Array of strings 参数解释: 设置NULL值的属性名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 rdmExtensionType 否 String 参数解释: 扩展类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应参数 状态码: 200 表9 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUC CES S:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of objects 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/statics 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。 默认取值: 不涉及。
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/statics { "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" : [ ], "funcs" : [ { "func" : "MAX", "funcBy" : "id" } ] } }
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP请求方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在管理员创建IAM用户的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users
  • 请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写。其中, accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中的“X-Subject-Token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,HTTPS的默认端口为443。 否 当使用AK/SK认证时,该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型(格式)。推荐用户使用默认值application/json,有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度,单位为Byte。 否 3495 Authorization 签名认证信息。 否 当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 - X-Sdk-Date 请求发送的时间。 否 当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 - X-Project-ID Project ID,项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求或者多project场景采用AK/SK认证的接口请求,则该字段必选。 e9993fc787d**********aa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ X-Domain-ID 账号ID。 否 AK/SK认证方式下,全局服务的接口调用时,需在请求消息头中携带X-Domain-ID。 - API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于管理员创建IAM用户接口,使用AK/SK方式认证时,添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
  • 请求URI 请求URI由如下部分组成。 {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点中获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”。 例如“?limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在管理员创建IAM用户的URI部分找到resource-path(/v3.0/OS-USER/users),拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 响应示例 状态码: 200 请求成功 { "status" : "200", "message" : "success", "data" : 1 } 状态码: 400 参数校验异常 { "error_code" : " IDT .06031001", "error_msg" : "{0} is required and cannot be empty." } 状态码: 500 API执行异常 { "status" : "500", "message" : "API执行异常", "data" : null }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 status String 响应状态 message String 响应信息 data Object 返回结果 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误代码 error_msg String 错误信息 状态码: 500 表4 响应Body参数 参数 参数类型 描述 status String 响应状态 message String 响应信息 data Object 返回结果
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/MultiViewModel/createView { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "versionId" : "1", "modifier" : "test1", "item" : { "id" : "1", "clazz" : "MultiViewItem" } } }
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "610123340111159296", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.406+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "MultiViewModel", "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" : "MultiViewModel", "name" : "多视图管理", "description" : "多视图管理", "kiaguid" : "18409de0386546f8af4bb6c1dc5cf50f", "securityLevel" : "internal", "master" : { "id" : "2", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.419+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "MultiViewModelMaster", "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" : "MultiViewModelMaster" }, "branch" : { "id" : "601060080799981568", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.464+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "MultiViewModelBranch", "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" : "MultiViewModelBranch", "version" : "A" }, "latest" : true, "latestIteration" : true, "versionCode" : 1, "iteration" : 1, "version" : "A", "latestVersion" : true, "workingCopy" : false, "workingState" : { "code" : "CHECKED_IN", "cnName" : "已检入", "enName" : "checked in", "alias" : "CHECKED_IN" }, "checkOutUserName" : null, "checkOutTime" : null, "preVersionId" : 1, "item" : { "id" : "1", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.464+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "MultiViewItem", "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" : "MultiViewItem" } } ], "errors" : [ ] }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of MultiViewModelViewDTO objects 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。 表7 MultiViewModelViewDTO 参数 参数类型 描述 branch MultiViewModelBranchViewDTO object 参数解释: 分支对象。 取值范围: 不涉及。 默认取值: 不涉及。 checkOutTime String 参数解释: 检出时间。 取值范围: 不涉及。 默认取值: 不涉及。 checkOutUserName String 参数解释: 检出人。 取值范围: 不涉及。 默认取值: 不涉及。 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 description String 参数解释: 描述信息。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 iteration Integer 参数解释: 迭代版本。 取值范围: 不涉及。 默认取值: 不涉及。 kiaguid String 参数解释: KIA密级。 取值范围: 不涉及。 默认取值: 不涉及。 lastUpdateTime String 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 latest Boolean 参数解释: 是否为最新版本。 取值范围: true:是最新版本。 false:不是最新版本。 默认取值: false。 latestIteration Boolean 参数解释: 是否为最新迭代版本。 取值范围: true:是最新迭代版本。 false:不是最新迭代版本。 默认取值: false。 latestVersion Boolean 参数解释: 是否为最新修订版本。 取值范围: true:是最新修订版本。 false:不是最新修订版本。 默认取值: false。 master MultiViewModelMasterViewDTO object 参数解释: 主对象。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 name String 参数解释: 中文名称。 取值范围: 不涉及。 默认取值: 不涉及。 preVersionId String 参数解释: 前序版本实例ID。 取值范围: 不涉及。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识,参数值为0或1。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 securityLevel String 参数解释: 安全密级。 取值范围: INTERNAL:内部公开。 SECRET:秘密。 CONFIDENTIAL:机密。 TOP_SECRET:绝密。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 version String 参数解释: 版本号。 取值范围: 不涉及。 默认取值: 不涉及。 versionCode Integer 参数解释: 业务版本内码。 取值范围: 不涉及。 默认取值: 不涉及。 workingCopy Boolean 参数解释: 是否已检出。 取值范围: true:已检出。 false:未检出。 默认取值: 不涉及。 workingState WorkingState object 参数解释: 工作状态。 取值范围: 不涉及。 默认取值: 不涉及。 item MultiViewItemViewDTO object 参数解释: 绑定的多视图对象。 取值范围: 不涉及。 默认取值: 不涉及。 表8 MultiViewModelBranchViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 lastUpdateTime String 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识,参数值为0或1。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 version String 参数解释: 版本号。 取值范围: 不涉及。 默认取值: 不涉及。 表9 MultiViewModelMasterViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 lastUpdateTime String 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识,参数值为0或1。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 表10 WorkingState 参数 参数类型 描述 alias String 参数解释: 别名。 取值范围: 不涉及。 默认取值: 不涉及。 cnName String 参数解释: 中文名称。 取值范围: 不涉及。 默认取值: 不涉及。 code String 参数解释: 编码。 取值范围: 不涉及。 默认取值: 不涉及。 enName String 参数解释: 英文名称。 取值范围: 不涉及。 默认取值: 不涉及。 表11 MultiViewItemViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识,参数值为0或1。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 lastUpdateTime Object 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 表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}/createView 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。 默认取值: 不涉及。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 否 MultiViewModelVersionViewCreateDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 表4 MultiViewModelVersionViewCreateDTO 参数 是否必选 参数类型 描述 modifier 否 String 参数解释: 修改人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 versionId 是 String 参数解释: 版本对象ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 workCopyType 否 String 参数解释: 关系的复制类型。 约束限制: 不涉及。 取值范围: BOTH:若存在关系实例引用此 数据实例 作为源端实例或目标端实例,创建多维版本后的数据实例将继承这些关系实例。 SOURCE:若存在关系实例引用此数据实例作为源端实例,创建多维版本后的数据实例将继承这些关系实例。 TARGET:若存在关系实例引用此数据实例作为目标端实例,创建多维版本后的数据实例将继承这些关系实例。 NONE:创建多维版本后的数据实例将不继承任何关系实例。 CUSTOM:若指定的关系实体集合对应的关系实例引用此数据实例作为源端实例或目标端实例,创建多维版本后的数据实例将继承这些关系实例。 默认取值: 不涉及。 customLinkSet 否 Array of strings 参数解释: 关系实体名称集合,与workCopyType的值CUSTOM配合使用。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 needSetNull 否 Array of strings 参数解释: 指定不复制的属性,其值将被设置为null。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 item 是 ObjectReferenceParamDTO object 参数解释: 引用对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表5 ObjectReferenceParamDTO 参数 是否必选 参数类型 描述 clazz 否 String 参数解释: 类名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 id 是 String 参数解释: 数据实例ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "601060080745455616", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.406+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "VersionModel", "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" : "VersionModel", "name" : "modifier name", "description" : "modifier description", "kiaguid" : "18409de0386546f8af4bb6c1dc5cf50f", "securityLevel" : "internal", "master" : { "id" : "601060080779010048", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.419+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "VersionModelMaster", "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" : "VersionModelMaster" }, "branch" : { "id" : "601060080799981568", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.464+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "VersionModelBranch", "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" : "VersionModelBranch", "version" : "A" }, "latest" : true, "latestIteration" : true, "versionCode" : 1, "iteration" : 1, "version" : "A", "latestVersion" : true, "workingCopy" : false, "workingState" : { "code" : "CHECKED_IN", "cnName" : "已检入", "enName" : "checked in", "alias" : "CHECKED_IN" }, "checkOutUserName" : null, "checkOutTime" : null, "preVersionId" : "601372141664866304" } ], "errors" : [ ] }
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/batchCheckin { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : [ { "masterId" : "602146893727801345", "modifier" : "test1" } ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of VersionModelViewDTO objects 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。 表6 VersionModelViewDTO 参数 参数类型 描述 branch VersionModelBranchViewDTO object 参数解释: 分支对象。 取值范围: 不涉及。 默认取值: 不涉及。 checkOutTime String 参数解释: 检出时间。 取值范围: 不涉及。 默认取值: 不涉及。 checkOutUserName String 参数解释: 检出人。 取值范围: 不涉及。 默认取值: 不涉及。 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 description String 参数解释: 描述信息。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 iteration Integer 参数解释: 迭代版本。 取值范围: 不涉及。 默认取值: 不涉及。 kiaguid String 参数解释: KIA密级。 取值范围: 不涉及。 默认取值: 不涉及。 lastUpdateTime String 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 latest Boolean 参数解释: 是否为最新版本。 取值范围: true:是最新版本。 false:不是最新版本。 默认取值: false。 latestIteration Boolean 参数解释: 是否为最新迭代版本。 取值范围: true:是最新迭代版本。 false:不是最新迭代版本。 默认取值: 不涉及。 latestVersion Boolean 参数解释: 是否为最新修订版本。 取值范围: true:是最新修订版本。 false:不是最新修订版本。 默认取值: 不涉及。 master VersionModelMasterViewDTO object 参数解释: 主对象。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 name String 参数解释: 中文名称。 取值范围: 不涉及。 默认取值: 不涉及。 preVersionId String 参数解释: 前序版本实例ID。 取值范围: 不涉及。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 0。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 securityLevel String 参数解释: 安全密级。 取值范围: INTERNAL:内部公开。 SECRET:秘密。 CONFIDENTIAL:机密。 TOP_SECRET:绝密。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 version String 参数解释: 版本号。 取值范围: 不涉及。 默认取值: 不涉及。 versionCode Integer 参数解释: 业务版本内码。 取值范围: 不涉及。 默认取值: 不涉及。 workingCopy Boolean 参数解释: 是否已检出。 取值范围: true:已检出。 false:未检出。 默认取值: false。 workingState WorkingState object 参数解释: 工作状态。 取值范围: 不涉及。 默认取值: 不涉及。 表7 VersionModelBranchViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 lastUpdateTime Object 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 0。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 version String 参数解释: 版本号。 取值范围: 不涉及。 默认取值: 不涉及。 表8 VersionModelMasterViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 lastUpdateTime String 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 0。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 表9 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 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 表10 WorkingState 参数 参数类型 描述 alias String 参数解释: 别名。 取值范围: 不涉及。 默认取值: 不涉及。 cnName String 参数解释: 中文名称。 取值范围: 不涉及。 默认取值: 不涉及。 code String 参数解释: 编码。 取值范围: 不涉及。 默认取值: 不涉及。 enName String 参数解释: 英文名称。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/batchCheckin 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。 默认取值: 不涉及。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 params 否 Array of VersionModelVersionCheckInDTO objects 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表4 VersionModelVersionCheckInDTO 参数 是否必选 参数类型 描述 masterId 是 String 参数解释: 主对象ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 modifier 否 String 参数解释: 更新者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/create { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "id" : "666", "tenant" : { "id" : "-1", "clazz" : "Tenant" }, "rdmExtensionType" : "PersistableModel", "creator" : "test1", "modifier" : "test1", "uniqueKey" : "union key new create" } }
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "573114063148556288", "creator" : "test1", "modifier" : "XDM_Developer xxx", "createTime" : "2023-12-04T03:50:40.599+0000", "lastUpdateTime" : "2023-12-04T03:50:40.599+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "TestG1", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2023-05-29T04:21:27.403+0000", "lastUpdateTime" : "2023-05-29T04:21:27.403+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" : "TestG1" } ], "errors" : [ ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 否 PersistableModelCreateDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表4 PersistableModelCreateDTO 参数 是否必选 参数类型 描述 createTime 否 String 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 creator 否 String 参数解释: 创建者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 id 否 String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 lastUpdateTime 否 String 参数解释: 最后更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 modifier 否 String 参数解释: 修改人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 rdmExtensionType 否 String 参数解释: 扩展类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 tenant 否 ObjectReferenceParamDTO object 参数解释: 租户信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 uniqueKey 否 String 参数解释: 示例模型的唯一键属性。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表5 ObjectReferenceParamDTO 参数 是否必选 参数类型 描述 clazz 否 String 参数解释: 类名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 id 是 String 参数解释: 数据实例ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of PersistableModelViewDTO objects 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。 表7 PersistableModelViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 0。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 lastUpdateTime Object 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 uniqueKey String 参数解释: 示例模型中定义的唯一键属性。 取值范围: 不涉及。 默认取值: 不涉及。 表8 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}/create 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。 默认取值: 不涉及。
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of objects 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/LifecycleManagedModel/updateState { "params" : [ { "id" : "1", "lifecycleState" : { "id" : "609794709757366272", "clazz" : "LifecycleState" }, "modifier" : "test1" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 否 Array of LifecycleManagedModelUpdateLifecycleStateDTO objects 参数解释: 迭代版本。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 表4 LifecycleManagedModelUpdateLifecycleStateDTO 参数 是否必选 参数类型 描述 id 是 String 参数解释: 数据实例ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 lifecycleState 是 ObjectReferenceParamDTO object 参数解释: 生命周期状态对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 modifier 否 String 参数解释: 修改人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表5 ObjectReferenceParamDTO 参数 是否必选 参数类型 描述 clazz 否 String 参数解释: 类名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 id 是 String 参数解释: 数据实例ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/updateState 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。 默认取值: 不涉及。
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "601060080745455616", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.406+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "VersionModel", "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" : "VersionModel", "name" : "modifier name", "description" : "modifier description", "kiaguid" : "18409de0386546f8af4bb6c1dc5cf50f", "securityLevel" : "internal", "master" : { "id" : "601060080779010048", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.419+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "VersionModelMaster", "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" : "VersionModelMaster" }, "branch" : { "id" : "601060080799981568", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.464+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "VersionModelBranch", "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" : "VersionModelBranch", "version" : "A" }, "latest" : true, "latestIteration" : true, "versionCode" : 1, "iteration" : 1, "version" : "A", "latestVersion" : true, "workingCopy" : false, "workingState" : { "code" : "CHECKED_IN", "cnName" : "已检入", "enName" : "checked in", "alias" : "CHECKED_IN" }, "checkOutUserName" : null, "checkOutTime" : null, "preVersionId" : "601372141664866304" } ], "errors" : [ ] }
共100000条