华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM 用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 PersistableModelUpdateDTO object 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 PersistableModelUpdateDTO 参数 是否必选 参数类型 描述 createTime 否 String 参数解释： 创建时间。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 creator 否 String 参数解释： 创建者。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 id 否 String 参数解释： 唯一标识。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime 否 String 参数解释： 最后更新时间。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 modifier 否 String 参数解释： 更新者。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 needSetNullAttrs 否 Array of strings 参数解释： 将自定义属性（包括基本属性和扩展属性）设置为空值，其长度不能超过1000个字符。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 rdmExtensionType 否 String 参数解释： 扩展类型。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 uniqueKey 否 String 参数解释： 示例模型的唯一键属性。 约束限制： 实例值不能重复。 取值范围： 不涉及。 默认取值： 不涉及。

响应参数 状态码： 200 表9 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUC CES S：请求成功。 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。

响应参数 状态码： 200 表9 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of PersistableModelViewDTO objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表10 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 参数解释： 示例模型中定义的唯一键属性。 取值范围： 不涉及。 默认取值： 不涉及。 表11 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 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。

响应示例 状态码： 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "572497983069757440", "creator" : "test1", "modifier" : "XDM_Developer xxx", "createTime" : "2023-12-02T11:02:36.000+0000", "lastUpdateTime" : "2023-12-04T03:54:44.000+0000", "rdmVersion" : 2, "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" : null } ], "errors" : [ ], "pageInfo" : { "curPage" : 1, "pageSize" : 10, "totalRows" : 1, "totalPages" : 1 } }

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/find/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" : [ ] } }

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/find/{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。

请求示例 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]个字符。 默认取值： 不涉及。

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

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

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/logicalDeleteByCondition { "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" } }

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/query/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" : [ { "id" : "123", "creator" : "test1", "createTime" : "2023-12-04T11:52:48.000+0000", "modifier" : "XDM_Developer xxx", "lastUpdateTime" : "2023-12-04T12:07:59.000+0000", "rdmExtensionType" : "PersistableModel", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "createTime" : "2023-12-01T01:25:21.000+0000", "modifier" : "xdmAdmin", "lastUpdateTime" : "2023-12-01T01:25:21.000+0000", "rdmExtensionType" : "Tenant", "tenant" : null, "className" : "Tenant", "name" : "basicTenant", "description" : "默认租户", "code" : "basicTenant", "disableFlag" : false, "dataSource" : "DefaultDataSource" }, "className" : "PersistableModel" } ], "errors" : [ ], "pageInfo" : { "curPage" : 1, "pageSize" : 10, "totalRows" : 1, "totalPages" : 1 } }

响应参数 状态码： 200 表9 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of PersistableModelQueryViewDTO objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表10 PersistableModelQueryViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 disableFlag Boolean 参数解释： 失效标识。 取值范围： true：失效。 false：未失效。 默认取值： false。 extAttrMap Object 参数解释： 扩展属性映射集。 取值范围： 不涉及。 默认取值： 不涉及。 extAttrs Array of EXAValueViewDTO objects 参数解释： 扩展属性列表。 取值范围： 不涉及。 默认取值： 不涉及。 folder FolderQueryViewDTO object 参数解释： 文件夹。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantQueryViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 表11 FolderQueryViewDTO 参数 参数类型 描述 businessCode String 参数解释： 编码。 取值范围： 不涉及。 默认取值： 不涉及。 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 description String 参数解释： 中文描述。 取值范围： 不涉及。 默认取值： 不涉及。 descriptionEn String 参数解释： 英文描述。 取值范围： 不涉及。 默认取值： 不涉及。 disableFlag Boolean 参数解释： 失效标识。 取值范围： true：失效。 false：未失效。 默认取值： false。 extAttrMap Object 参数解释： 扩展属性映射集。 取值范围： 不涉及。 默认取值： 不涉及。 extAttrs Array of EXAValueViewDTO objects 参数解释： 扩展属性列表。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 nameEn String 参数解释： 英文名称。 取值范围： 不涉及。 默认取值： 不涉及。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantQueryViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 type String 参数解释： 类别。 取值范围： 不涉及。 默认取值： 不涉及。 表12 EXAValueViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 type String 参数解释： 类型。 取值范围： 不涉及。 默认取值： 不涉及。 value Object 参数解释： 值。 取值范围： 不涉及。 默认取值： 不涉及。 表13 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 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 表14 TenantQueryViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 code String 参数解释： 租户编码。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 dataSource String 参数解释： 租户使用的数据源名称。 取值范围： 不涉及。 默认取值： 不涉及。 description String 参数解释： 描述信息。 取值范围： 不涉及。 默认取值： 不涉及。 disableFlag Boolean 参数解释： 失效标识。 取值范围： true：失效。 false：未失效。 默认取值： false。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantQueryViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/query/{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。

场景示例 根据产品类型按月汇总6~8月的成本数据。 汇总结果如下图所示：成本消耗最多的是云硬盘 EVS。 查看虚拟私有云按区域的汇总情况。 汇总结果如下图所示：查询范围内的成本消耗大部分都在“华北-北京一”。 查看华北-北京一的虚拟私有云按计费模式的汇总情况。 汇总结果如下图所示：查询范围内的成本消耗大部分为按需模式。 您还可以继续按其他汇总维度继续查看汇总情况。 不同汇总维度均可保存为自定义报告，便于再次查看。

场景示例 成本中心提供了异常成本监控能力，可以帮助客户及时发现异常的按需、包年包月消费，避免不必要的支出。然而，许多客户不了解成本中心异常成本监控的能力，没有创建成本监控器，导致未能及时发现成本异常，产生了非必要支出。基于上述情况，成本中心自动为近7天有过消费的V3及以上客户创建了全局监控器，监控客户的所有云服务的消费。当异常影响成本超过1000元时，会为客户默认的账号联系人发送通知。客户会在每周一上午统一收到上一周的所有异常成本。 若系统预置的通知属性（通知阈值、通知频率、接收人等）不符合客户的实际情况，支持客户修改。 若客户不需要监控成本异常情况，可删除异常成本监控器。 了解异常成本规则请查看：异常成本规则。 系统自动为客户创建全局监控器后，会为客户发送自动创建成功通知。此通知并非异常成本告警。 异常成本监控为免费功能。

通过覆盖率分析资源包使用情况 场景示例：查看OBS按需资源的资源包覆盖率分析，其中使用量类型为容量:Byte ( 对象存储服务 : 云存储 :size)；周期为2022/01/01~2022/03/14。 如上图所示，华北-北京四区域资源包内用量（即按需资源抵扣的资源包用量）为115,675,329,596,488.00 Byte，按需用量（即未使用资源包抵扣的用量）为64,456,967,859,866.00 Byte，则覆盖率=资源包内用量/按需资源总用量*100%=115,675,329,596,488.00/(115,675,329,596,488.00+64,456,967,859,866.00)*100%=64.22%。 当前资源包平均覆盖率未到100%，您可以检查是否OBS资源包购买不足。 从柱状图中可以发现，2022/01/29号之后，资源包覆盖率突然变低，您通过如下情况分析覆盖率变低的原因： 检查是否使用量陡增：进入成本中心的“成本分析”页面，查看按需使用量情况。如下图所示，表示按需用量平稳，没有陡增。 检查是否原有资源包到期：进入费用中心的“资源包”页面，查看资源包明细信息。如下图所示，表示资源包在2022/01/28号到期，建议及时为资源包续费或再次购买。

通过使用率分析资源包使用情况 场景示例：客户购买OBS的包年资源包，按小时重置40GB的存储空间，订购周期为2021/04/30~2022/04/30。当前客户想要查看近3个月（即2021/12/01~2022/02/28）存储空间的使用率情况，查看周期内该资源包总使用量为40GB*24h*90天*1,073,741,824Byte=92,771,293,593,600 Byte 如上图所示，实际已使用量（即被按需资源抵扣的总用量）为16,060,131,693 Byte，资源包未使用量（即未被抵扣的使用量）为92,755,233,461,907 Byte，则使用率=资源包已使用量/资源包总使用量*100%=16,060,131,693/92,771,293,593,600*100%=0.02%。 由于当前平均使用率过低，您可以检查是否资源包购买数量过多，或按需资源没有按照资源包的规格开通。

步骤三：分析异常成本原因 在“异常成本详细信息”页面，单击潜在产品操作列的“前往对应成本分析查看”。 跳转到“成本分析”页面后，过滤器中会自动携带过滤条件。 如图所示，表示2024.6.3云硬盘产生了额外的新购，消费了3.50元，您需要确认该新购是否为异常消费。 您可以选择按“企业项目”维度进行汇总， 查看异常消费比较多的企业项目。 如下图所示，表示2024.6.3云硬盘产生异常新购消费中，没有特别设置企业项目的消费为3.50元。

成本分配的建议原则 基于实际使用，即成本归属于实际使用者。 示例：企业子客户是资源的使用者，但是支付账号为企业主，则该资源产生的成本归属为企业子。 基于实际消耗，即根据摊销成本进行分配。 摊销成本反映了包年/包月、预留实例的预付金额在订单有效期间内按日分摊后的有效成本。比如您购买了有效期为一年的云服务共365元，则每天的摊销成本为1元。 分摊公共成本，即根据一定的规则，对公共成本进行拆分。 按比例拆分：按照各目标成本的权重作为分配比例的参考。 示例：拆分目标B的成本是800元，拆分目标C的成本是200元，即拆分目标B:拆分目标C=4:1，则将拆分来源80%的成本分配给B，20%分配给C。 平均拆分：将拆分来源的成本平均分配给各拆分目标。 示例：当前存在两个拆分目标A和B，则拆分目标A和B分别被分配到50%。 自定义拆分：将拆分来源的成本按照您自定义的比例分配给各拆分目标，比例总计必须为100%。

SDK列表 在开始使用之前，请确保您安装的是最新版本的SDK。使用过时的版本可能会导致兼容性问题或无法使用最新功能。您可以在 SDK中心 查询版本信息。 表1提供了各个CCE服务支持的SDK列表，您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 参考文档 Java huaweicloud-sdk-java-v3 Java SDK使用指导 Python huaweicloud-sdk-python-v3 Python SDK使用指导 Go huaweicloud-sdk-go-v3 Go SDK使用指导 Node.js huaweicloud-sdk-nodejs-v3 Node.js SDK使用指导 .NET huaweicloud-sdk-net-v3 .NET SDK使用指导

建议示例 成本分配示例： 未激活成本标签：我们发现您有在使用的资源标签，但您没有激活的成本标签，推荐您将与成本归属有关的标签激活为成本标签，便于您分析和跟踪相关成本。 成本监控示例： 无异常成本通知：我们发现您近期有异常成本记录，但尚未设置异常成本通知，建议您设置异常成本通知，便于您及时获取异常。 资源包低使用率示例： 资源包低使用率建议项：我们发现您近期有2个资源包使用率低，建议您及时查看指定时间范围内某类资源包的实际使用情况，以了解资源包是否得到充分的利用或购买足够，避免浪费。 资源包低使用率规则如下： 按小时重置的资源包：过去7天，使用率低于20%。 按订购月重置的资源包：过去7天，使用率低于20%；过去14天，使用率低于40%。 表1 资源包使用率参数说明 参数 说明 关联账号 云资源实际归属的华为云账号。 企业主账号可以通过关联账号，选择关联的子账号进行成本数据的过滤和分析。 产品类型 资源包所属的产品类型。 资源包重置类型 按小时重置的资源包：展示每个分析粒度下的平均使用率趋势。 按订购月重置的资源包：展示每个分析粒度下的平均使用率趋势。 资源包名称/ID 资源包名称/ID。 资源包实例ID 资源包实例ID。 使用率 统计周期内，资源包被抵扣的比例。 使用率=抵扣用量/可用总量*100% 参考周期 资源包重置周期： 小时级重置：每小时 订购月重置：每个订购月的起始时间，例如每月15日~次月14日。

成本分配情况 成本分配情况为您提供在不同成本分配方式下的未分配成本占比，这部分成本在组织中无法分配给具体的应用、团队或其他维度。未分配占比越低，说明您的成本分配执行的效果越好，组织中的成本分配越清晰。 成本分配情况最多为您显示5个成本分配方式的未分配占比数据。 若您的成本标签或成本单元超过5个，可以通过“设置”来选择指定的成本标签或成本单元。 未分配占比：按照企业项目、成本标签及成本单元三种成本分配方式统计。 企业项目：未归属到对应企业项目中的成本（default和未归集）占当月至今总成本的占比。 成本单元：未应用到对应成本单元规则中的成本（未分配和未归集）占当月至今总成本的占比。 成本标签：未匹配到对应成本标签中的成本（未归集）占当月至今总成本的占比。 环比上月：（当月至今未分配成本占比-上月未分配成本占比）/上月未分配成本占比。

自定义参数说明 在目的端配置中，支持配置的自定义参数及说明请参见表1和conf参数说明。 表1 支持的自定义参数说明 参数名称 取值范围 说明 是否必填 spark.dli.metaAccess.enable - 填写true。 是 spark.dli.job.agency.name 填写 DLI 委托权限名称。 mgc.mc2dli.data.migration.dli.file.path 填写存放migration-dli-spark-1.0.0.jar包的OBS路径。例如：obs://mgc-test/data/migration-dli-spark-1.0.0.jar mgc.mc2dli.data.migration.dli.spark.jars 填写存放fastjson-1.2.54.jar和datasource.jar包的OBS路径，以数组形式传入，路径带双引号，以英文逗号隔开。例如：["obs://mgc-test/data/datasource.jar","obs://mgc-test/data/fastjson-1.2.54.jar"] spark.sql.catalog.mc_catalog.tableWriteProvider 填写tunnel 专线迁移场景为必填 spark.sql.catalog.mc_catalog.tableReadProvider 填写tunnel spark.hadoop.odps.end.point 填写源端MaxCompute服务所在地域的VPC网络Endpoint信息。各地域VPC网络Endpoint信息请参考Endpoint对照表。例如：源端所在地域为“香港”，则填写“http://service.cn-hongkong.maxcompute.aliyun-inc.com/api” spark.hadoop.odps.tunnel.end.point 填写源端MaxCompute服务所在地域的VPC网络Tunnel Endpoin信息。各地域VPC网络Tunnel Endpoin信息请参考Endpoint对照表。例如：源端所在地域为“香港”，则填写“http://dt.cn-hongkong.maxcompute.aliyun-inc.com” sc_type A、B、C 计算资源类型，目前指定参数A, B, C。如果不指定，则按最小类型创建。 A：(8核32G内存，driverCores：2，executorCores：1，driverMemory：7G，executorMemory：4G，numExecutor：6) B：(16核64G内存，driverCores：2，executorCores：2，driverMemory：7G，executorMemory：8G，numExecutor：7) C：(32核128G内存，driverCores：4，executorCores：2，driverMemory：15G，executorMemory：8G，numExecutor：14) 否 executorCores 1- 4 Spark应用每个Executor的CPU核数。该配置项会替换“sc_type”中对应的默认参数。 numExecutors 1-100 Spark应用Executor的个数。该配置项会替换“sc_type”中对应的默认参数。 executorMemory 1-16 G Spark应用的Executor内存，参数配置例如：2G, 2048M。该配置项会替换“sc_type”中对应的默认参数，使用时必需带单位，否则会启动失败。 driverCores 1-4 Spark应用Driver的CPU核数。该配置项会替换“sc_type”中对应的默认参数。 driverMemory 1-16 G Spark应用的Driver内存，参数配置例如：2G, 2048M。该配置项会替换“sc_type”中对应的默认参数，使用时必需带单位，否则会启动失败。 父主题： 大数据数据迁移

准备工作 创建迁移项目。 通过应用发现，完成主机资源的发现与采集。MgC提供了三种主机采集方式，您可以根据实际场景和您源端主机所在的云平台，选择适合的采集方式。 源端主机位于云平台：源端为阿里云、华为云、AWS、腾讯云、Azure等云平台主机，推荐使用公网采集，也可以使用各场景通用的手动添加方式。 源端主机位于线下IDC：推荐使用内网采集，通过网段扫描或VMware扫描，采集源端主机资源，也可以使用各场景通用的手动添加方式。 在源端内网环境中安装迁移工具Edge并注册用户，方法和要求请参见安装Windows版本的Edge。安装并注册成功后，将Edge与云端MgC控制台建立连接，方法请参考连接迁移中心。