华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

响应示例 状态码： 200 Success，返回data数据是 WorkspaceVO 数组, 以及总数 { "data" : { "value" : { "records" : [ { "id" : "1014218815216717824", "name" : "test", "description" : "abc", "is_physical" : true, "frequent" : false, "top" : true, "level" : "SDI", "dw_type" : " DLI ", "create_time" : "2022-08-30T17:03:28.822+08:00", "update_time" : "2022-08-30T17:03:28.822+08:00", "create_by" : "abc", "update_by" : "abc", "type" : "THIRD_NF", "biz_catalog_ids" : null, "databases" : null } ] } } }

URI GET /v2/{project_id}/design/workspaces 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 workspace_type 否 String 枚举值： THIRD_NF DIMENSION limit 否 Integer 查询条数，即查询Y条数据。默认值50，取值范围[1,100] 最大值：100 缺省值：50 offset 否 Integer 查询起始坐标，即跳过X条数据，仅支持0或limit的整数倍，不满足则向下取整。默认值0 缺省值：0 dw_type 否 String 数据连接类型

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

响应示例 状态码： 200 Success，返回数据是DirectoryVO { "data" : { "value" : { "name" : "test", "description" : null, "type" : "CODE", "id" : "1036594387779555328", "parent_id" : null, "prev_id" : "1036594387779555328", "root_id" : "1036594387779555328", "qualified_name" : null, "create_time" : null, "update_time" : null, "create_by" : null, "update_by" : "7b71e498e75d44048c9a22dd3c54f978", "children" : null } } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio 工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 名称 最大长度：200 description 否 String 描述 type 是 String 目录类型(数据标准、码表) 枚举值： STANDARD_ELEMENT CODE id 否 Long ID，创建时可不传，更新时必填 parent_id 是 Long 父目录ID,首层传null prev_id 是 Long 上个节点ID,首节点传null root_id 否 Long 根节点ID,根节点此ID为自身ID qualified_name 否 String 所属目录 create_time 否 String 创建时间 update_time 否 String 更新时间 create_by 否 String 创建人 update_by 否 String 更新人 children 否 Array of DirectoryVO objects 子目录

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

响应示例 状态码： 200 Success，返回data数据是 BizMetricVO { "data" : { "value" : { "id" : "1036590187955851264", "name" : "业务指标实例", "code" : "ZB000000", "name_alias" : "bizMetricDemo", "biz_type" : null, "status" : "DRAFT", "biz_catalog_id" : "1029701703198519304", "biz_catalog_path" : "营销/门店营销/门店", "create_by" : "ei_dlf_l00341563", "update_by" : "ei_dlf_l00341563", "data_origin" : "", "unit" : "", "time_filters" : "天", "dimensions" : "公司", "general_filters" : "example", "interval_type" : "DAY", "apply_scenario" : "", "technical_metric" : null, "technical_metric_name" : null, "technical_metric_type" : null, "measure" : "", "owner" : "tester", "owner_department" : "testDep", "destination" : "example", "guid" : null, "definition" : "example", "expression" : "a+b+c", "remark" : "example", "approval_info" : null, "new_biz" : null, "create_time" : "2022-10-31T10:39:20+08:00", "update_time" : "2022-10-31T10:39:20+08:00", "l1" : "营销", "l2" : "门店营销", "l3" : "门店", "biz_metric" : null, "summary_status" : null } } }

请求示例 { "code" : "ZB000000", "biz_catalog_id" : "1029701703198519304", "name" : "业务指标实例", "name_alias" : "bizMetricDemo", "destination" : "example", "definition" : "example", "expression" : "a+b+c", "data_origin" : "", "unit" : "", "time_filters" : "天", "dimensions" : "公司", "general_filters" : "example", "interval_type" : "DAY", "apply_scenario" : "", "technical_metric" : "", "measure" : "", "owner_department" : "testDep", "owner" : "tester", "remark" : "example", "id" : "1036590187955851264" }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 Long 编码, 更新时必填，创建是为空 name 是 String 指标名称 最大长度：500 code 否 String 指标编码 name_alias 否 String 指标别名 最大长度：500 biz_type 否 String 业务类型 枚举值： ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_ LOG IC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT status 否 String 业务状态 枚举值： DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT biz_catalog_id 是 Long 归属的流程架构的id biz_catalog_path 否 String 归属的流程架构路径 create_by 否 String 创建人 update_by 否 String 更新人 data_origin 否 String 数据来源 最大长度：1000 unit 否 String 计量单位 最大长度：50 time_filters 是 String 统计周期(时间限定) 最大长度：500 dimensions 否 String 统计维度 最大长度：1000 general_filters 否 String 统计口径和修饰词 最大长度：1000 interval_type 是 String 刷新频率 缺省值：DAY 枚举值： MINUTE HOUR DAY WEEK MONTH YEAR REAL_TIME HALF_HOUR QUART DOUBLE_WEEK HALF_YEAR HALF_DAY apply_scenario 否 String 应用场景 最大长度：255 technical_metric 否 Long 关联技术指标 technical_metric_name 否 String 关联技术指标名称 technical_metric_type 否 String 业务类型 枚举值： ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT measure 否 String 度量对象 最大长度：255 owner 是 String 指标责任人 最大长度：100 owner_department 是 String 指标管理部门 最大长度：600 destination 是 String 设置目的 最大长度：1000 guid 否 String 资产同步后的guid definition 是 String 指标定义 最大长度：1000 expression 是 String 计算公式 最大长度：1000 remark 否 String 备注 最大长度：600 approval_info 否 ApprovalVO object 审批信息 new_biz 否 BizVersionManageVO object 业务版本管理. create_time 否 String 创建时间 update_time 否 String 更新时间 l1 否 String 主题域分组中文名 l2 否 String 主题域中文名 l3 否 String 业务对象中文名 biz_metric 否 String 业务指标同步状态 枚举值： NO_NEED CREATE_SUC CES S CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE summary_status 否 String 同步统计状态 枚举值： NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE 表4 ApprovalVO 参数 是否必选 参数类型 描述 id 否 Long ID tenant_id 否 String tenant id name_ch 否 String 业务中文名 name_en 否 String 业务英文名 biz_id 否 Long 业务ID biz_type 否 String 业务类型 枚举值： ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_info 否 String 业务详情 biz_info_obj 否 Object 业务详情 biz_version 否 Integer 业务版本 biz_status 否 String 业务状态 枚举值： DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT approval_status 否 String 业务审批状态 枚举值： DEVELOPING APPROVED REJECT WITHDREW approval_type 否 String 业务审核类型 枚举值： PUBLISH OFFLINE submit_time 否 String 提交时间 create_by 否 String 创建者 l1 否 String 主题域分组 l2 否 String 主题域 l3 否 String 业务对象 approval_time 否 String 审核时间 approver 否 String 审核人 email 否 String 审核人邮箱 msg 否 String 审核信息 directory_path 否 String 目录树 表5 BizVersionManageVO 参数 是否必选 参数类型 描述 id 否 Long ID信息 biz_type 否 String 业务类型 枚举值： ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_id 否 Long 业务id biz_info 否 String 业务对象信息 status 否 String 业务状态 枚举值： DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT biz_version 否 Integer 业务版本 create_time 否 String 创建时间 update_time 否 String 更新时间

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 levels 否 Array of CatalogLevelVO objects 主题层级信息 数组长度：2 - 7 表4 CatalogLevelVO 参数 是否必选 参数类型 描述 id 否 Long 编号 level 否 Integer 层级 name_ch 否 String 中文名称 name_en 否 String 英文名称

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

请求示例 { "levels" : [ { "id" : "873154228410097664", "level" : 1, "name_ch" : "主题域分组", "name_en" : "Business Domain Group" }, { "id" : "873154228414291968", "level" : 2, "name_ch" : "主题域", "name_en" : "Business Domain" }, { "id" : "873154228414291969", "level" : 3, "name_ch" : "业务对象", "name_en" : "Business Object" } ] }

URI GET /v2/{project_id}/design/customized-fields 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询条数，即查询Y条数据。默认值50，取值范围[1,100] 最大值：100 缺省值：50 offset 否 Integer 查询起始坐标，即跳过X条数据，仅支持0或limit的整数倍，不满足则向下取整。默认值0 缺省值：0 type 是 String 枚举值： TABLE ATTRIBUTE SUBJECT

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

响应示例 状态码： 200 Success { "data" : { "value" : { "records" : [ { "id" : "1033443457986891776", "name_ch" : "自定义", "name_en" : "zdy", "not_null" : true, "optional_values" : "aaa;bbb", "type" : "TABLE", "ordinal" : 0, "description" : "自定义项", "create_by" : "tester", "update_by" : "tester", "create_time" : "2022-08-30T17:03:29+08:00", "update_time" : "2022-08-30T17:03:29+08:00" } ] } } }

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

请求示例 { "id" : 0, "directory_id" : "793889791589650432", "values" : [ { "fd_name" : "nameEn", "fd_value" : "demo" }, { "fd_name" : "dataType", "fd_value" : "STRING" }, { "fd_name" : "dataLength", "fd_value" : "128" }, { "fd_name" : "hasAllowValueList", "fd_value" : false }, { "fd_name" : "allowList", "fd_value" : "" }, { "fd_name" : "referCodeTable", "fd_value" : "885123958788317184" }, { "fd_name" : "codeStandColumn", "fd_value" : "52470" }, { "fd_name" : "dqcRule", "fd_value" : "" }, { "fd_name" : "ruleOwner", "fd_value" : "liuxu" }, { "fd_name" : "dataMonitorOwner", "fd_value" : "liuxu" }, { "fd_name" : "standardLevel", "fd_value" : "domain" }, { "fd_name" : "description", "fd_value" : "这是一个demo" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 values 是 Array of StandElementValueVO objects 属性信息 id 否 Long ID directory_id 是 Long 标准所属目录 directory_path 否 String 目录树 row_id 否 Long 标准行的id status 否 String 业务状态 枚举值： DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT approval_info 否 ApprovalVO object 审批信息 new_biz 否 BizVersionManageVO object 业务版本管理. create_by 否 String 创建人 update_by 否 String 更新人 create_time 否 String 创建时间 update_time 否 String 更新时间 表4 StandElementValueVO 参数 是否必选 参数类型 描述 fd_name 是 String 属性名称 fd_value 否 String 属性值 fd_id 否 Long 属性定义的id directory_id 否 Long 标准所属目录 row_id 否 Long 标准所属行 id 否 Long ID status 否 String 业务状态 枚举值： DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT create_by 否 String 创建人 update_by 否 String 更新人 create_time 否 String 创建时间 update_time 否 String 更新时间 表5 ApprovalVO 参数 是否必选 参数类型 描述 id 否 Long ID tenant_id 否 String tenant id name_ch 否 String 业务中文名 name_en 否 String 业务英文名 biz_id 否 Long 业务ID biz_type 否 String 业务类型 枚举值： ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_info 否 String 业务详情 biz_info_obj 否 Object 业务详情 biz_version 否 Integer 业务版本 biz_status 否 String 业务状态 枚举值： DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT approval_status 否 String 业务审批状态 枚举值： DEVELOPING APPROVED REJECT WITHDREW approval_type 否 String 业务审核类型 枚举值： PUBLISH OFFLINE submit_time 否 String 提交时间 create_by 否 String 创建者 l1 否 String 主题域分组 l2 否 String 主题域 l3 否 String 业务对象 approval_time 否 String 审核时间 approver 否 String 审核人 email 否 String 审核人邮箱 msg 否 String 审核信息 directory_path 否 String 目录树 表6 BizVersionManageVO 参数 是否必选 参数类型 描述 id 否 Long ID信息 biz_type 否 String 业务类型 枚举值： ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_id 否 Long 业务id biz_info 否 String 业务对象信息 status 否 String 业务状态 枚举值： DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT biz_version 否 Integer 业务版本 create_time 否 String 创建时间 update_time 否 String 更新时间

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

URI GET /v2/{project_id}/design/biz-metrics/owners 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询条数，即查询Y条数据。默认值50，取值范围[1,100] 最大值：100 缺省值：50 offset 否 Integer 查询起始坐标，即跳过X条数据，仅支持0或limit的整数倍，不满足则向下取整。默认值0 缺省值：0

响应示例 状态码： 200 Success，返回data数据是 RelationVO 详情 { "data" : { "value" : { "id" : "1000068927784710144", "source_table_id" : "873243083737899008", "target_table_id" : "888462883313393664", "name" : "sdi_taxi_trip_data_wang_1", "source_table_name" : "demo_sdi_db.sdi_taxi_trip_data", "target_table_name" : "default.wang", "role" : null, "tenant_id" : "xxx", "source_type" : "ONE_OR_N", "target_type" : "ONE_OR_N", "create_by" : "abc", "update_by" : "abc", "create_time" : "2022-07-22T15:56:53+08:00", "update_time" : "2022-07-22T15:57:28+08:00", "mappings" : [ { "id" : "1000068927818264576", "relation_id" : "1000068927784710144", "source_field_id" : "873243083737899013", "target_field_id" : "888462883317587968", "source_field_name" : "trip_distance", "target_field_name" : "id", "create_by" : "abc", "update_by" : "abc", "create_time" : "2022-07-22T15:56:53+08:00", "update_time" : "2022-07-22T15:57:28+08:00" } ] } } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

URI GET /v2/{project_id}/design/biz-metrics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 按名称或编码模糊查询 create_by 否 String 按创建者查询 owner 否 String 按负责人查询 status 否 String 业务状态 枚举值： DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT sync_status 否 String 枚举值： RUNNING NO_NEED SUMMARY_SUCCESS SUMMARY_FAILED sync_key 否 Array 枚举值： BUSINESS_ASSET DATA_QUALITY TECHNICAL_ASSET META_DATA_LINK PHYSICAL_TABLE DLF_TASK MATERIALIZATION biz_catalog_id 否 String 所属的业务分层的id begin_time 否 String 时间过滤左边界,与end_time一起使用,只支持时间范围过滤,单边过滤无效 end_time 否 String 时间过滤右边界,与begin_time一起使用只支持时间范围过滤,单边过滤无效 limit 否 Integer 查询条数，即查询Y条数据。默认值50，取值范围[1,100] 最大值：100 缺省值：50 offset 否 Integer 查询起始坐标，即跳过X条数据，仅支持0或limit的整数倍，不满足则向下取整。默认值0 缺省值：0

响应示例 状态码： 200 Success，返回data数据是 BizMetricVO 数组, 以及总数 { "data" : { "value" : { "records" : [ { "id" : "902866491765080064", "name" : "总车费", "code" : "ZB000001", "name_alias" : "", "biz_type" : null, "status" : "PUBLISHED", "biz_catalog_id" : "887366192090767360", "biz_catalog_path" : null, "create_by" : "abc", "update_by" : "abc", "data_origin" : "", "unit" : "", "time_filters" : "天", "dimensions" : "test", "general_filters" : "", "interval_type" : "REAL_TIME", "apply_scenario" : "", "technical_metric" : "873265992019640320", "technical_metric_name" : "总车费1(供应商)", "technical_metric_type" : "DERIVATIVE_INDEX", "measure" : "", "owner" : "abc", "owner_department" : "数据管理部", "destination" : "统计出租车公司收入", "guid" : "2c993087-2aff-43f7-9252-178ce52e7e7c", "definition" : "出租车公司收入", "expression" : "sum ( 总车费 )", "remark" : "", "approval_info" : { "id" : "933768706708971520", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "902866491765080064", "biz_type" : null, "biz_info" : null, "biz_info_obj" : null, "biz_version" : 0, "biz_status" : "PUBLISHED", "approval_status" : "APPROVED", "approval_type" : null, "submit_time" : "2022-01-20T17:03:28+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2022-01-20T17:03:28+08:00", "approver" : "abc", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null, "create_time" : "2021-10-27T10:29:06+08:00", "update_time" : "2022-01-20T17:03:28+08:00", "l1" : "L1", "l2" : null, "l3" : null, "biz_metric" : "UPDATE_SUCCESS", "summary_status" : "SUMMARY_SUCCESS" } ] } } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

响应示例 状态码： 200 Success，返回data数据是 AggregationLogicTableVO 数组, 以及总数 { "data" : { "value" : { "records" : [ { "id" : "874242075850342400", "tb_name" : "dws_rate_code", "tb_logic_name" : "费率代码汇总", "l1_id" : "873232498044411904", "l2_id" : "873232716601204736", "l3_id" : "873233519286059008", "description" : "无", "owner" : "abc", "create_by" : "abc", "queue_name" : "dgc_dli_test", "dw_id" : "2c9080f07b03db8d017b198a4a20002f", "db_name" : "demo_dm_db", "tb_id" : "NativeTable-2c9080f07b03db8d017b198a4a20002f-demo_dm_db-dws_rate_code", "schema" : "", "dw_name" : null, "status" : "PUBLISHED", "tb_guid" : "a268644b-31b6-42e5-84ec-e35c31b541a5", "tb_logic_guid" : "8948f715-3567-4684-9950-e3ed01e77121", "dw_type" : "DLI", "l1" : "城市交通", "l2" : "行程记录", "l3" : "记录统计", "create_time" : "2021-08-09T10:45:54+08:00", "update_time" : "2021-09-26T15:36:53+08:00", "approval_info" : { "id" : "874242076399796224", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "874242075850342400", "biz_type" : null, "biz_info" : null, "biz_info_obj" : null, "biz_version" : 0, "biz_status" : "PUBLISHED", "approval_status" : "APPROVED", "approval_type" : null, "submit_time" : "2021-08-09T10:45:54+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2021-08-09T10:45:53+08:00", "approver" : "abc", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null, "dimension_group" : "873252544997130240", "group_name" : "费率代码", "group_code" : null, "time_period" : { "id" : "874242075984560130", "aggregation_logic_table_id" : "874242075850342400", "ordinal" : 1, "name_en" : "dtime", "name_ch" : "统计日期", "attribute_type" : "SUMMARY_TIME", "is_primary_key" : false, "is_partition_key" : true, "not_null" : false, "description" : null, "data_type" : "TIMESTAMP", "domain_type" : "DATETIME", "data_type_extend" : null, "ref_id" : null, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null }, "table_attributes" : [ { "id" : "874242075984560130", "aggregation_logic_table_id" : "874242075850342400", "ordinal" : 1, "name_en" : "dtime", "name_ch" : "统计日期", "attribute_type" : "SUMMARY_TIME", "is_primary_key" : false, "is_partition_key" : true, "not_null" : false, "description" : null, "data_type" : "TIMESTAMP", "domain_type" : "DATETIME", "data_type_extend" : null, "ref_id" : null, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null }, { "id" : "874242075984560131", "aggregation_logic_table_id" : "874242075850342400", "ordinal" : 2, "name_en" : "sum_total_amount", "name_ch" : "总车费(费率代码)", "attribute_type" : "DERIVATIVE_INDEX", "is_primary_key" : false, "is_partition_key" : false, "not_null" : false, "description" : "", "data_type" : "DOUBLE", "domain_type" : "NUMBER", "data_type_extend" : null, "ref_id" : "873265784540004352", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null }, { "id" : "874242075984560132", "aggregation_logic_table_id" : "874242075850342400", "ordinal" : 3, "name_en" : "dim_rate_code_rate_code_id", "name_ch" : "费率代码_费率id", "attribute_type" : "SUMMARY_DIMENSION_ATTRIBUTE", "is_primary_key" : false, "is_partition_key" : false, "not_null" : true, "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : null, "ref_id" : "873252544997130240.873258130849636352", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null }, { "id" : "874242075984560133", "aggregation_logic_table_id" : "874242075850342400", "ordinal" : 4, "name_en" : "dim_rate_code_rate_code_value", "name_ch" : "费率代码_费率说明", "attribute_type" : "SUMMARY_DIMENSION_ATTRIBUTE", "is_primary_key" : false, "is_partition_key" : false, "not_null" : false, "description" : "", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : null, "ref_id" : "873252544997130240.873258130849636353", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null } ], "physical_table" : "CREATE_SUCCESS", "technical_asset" : "UPDATE_SUCCESS", "business_asset" : "UPDATE_SUCCESS", "meta_data_link" : "UPDATE_SUCCESS", "data_quality" : "UPDATE_SUCCESS", "dlf_task" : "CREATE_SUCCESS", "publish_to_dlm" : "NO_NEED", "summary_status" : "SUMMARY_SUCCESS", "distribute" : null, "distribute_column" : null, "table_type" : "MANAGED", "dlf_task_id" : "demo_dm_db_dws_rate_code_874242075850342400", "quality_id" : "874242188178075649", "reversed" : null, "table_version" : 0, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "alias" : "", "self_defined_fields" : [ ], "api_id" : null } ] } } }

URI GET /v2/{project_id}/design/aggregation-logic-tables 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 按名称或编码模糊查询 create_by 否 String 按创建者查询 approver 否 String 按审核人查询 owner 否 String 按负责人查询 status 否 String 业务状态 枚举值： DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT sync_status 否 String 枚举值： RUNNING NO_NEED SUMMARY_SUCCESS SUMMARY_FAILED sync_key 否 Array 枚举值： BUSINESS_ASSET DATA_QUALITY TECHNICAL_ASSET META_DATA_LINK PHYSICAL_TABLE DLF_TASK MATERIALIZATION l3_id 否 Long 业务对象l3 id begin_time 否 String 时间过滤左边界,与end_time一起使用,只支持时间范围过滤,单边过滤无效 end_time 否 String 时间过滤右边界,与begin_time一起使用只支持时间范围过滤,单边过滤无效 limit 否 Integer 查询条数，即查询Y条数据。默认值50，取值范围[1,100] 最大值：100 缺省值：50 offset 否 Integer 查询起始坐标，即跳过X条数据，仅支持0或limit的整数倍，不满足则向下取整。默认值0 缺省值：0 biz_catalog_id 否 String 所属的业务分层的id auto_generate 否 Boolean 是否自动生成

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息