华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 响应参数 状态码: 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/dimensions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 按名称或编码模糊查询 create_by 否 String 按创建者查询 approver 否 String 按审核人查询 status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT l2_id 否 Long 主题域l2 id derivative_ids 否 Array 依据复合指标id列表查维度 begin_time 否 String 时间过滤左边界,与end_time一起使用,只支持时间范围过滤,单边过滤无效 end_time 否 String 时间过滤右边界,与begin_time一起使用只支持时间范围过滤,单边过滤无效 fact_logic_id 否 Long 事实表id dimension_type 否 String 维度类型 枚举值: COMMON LOOKUP HIERARCHIES limit 否 Integer 查询条数,即查询Y条数据。默认值50,取值范围[1,100] 最大值:100 缺省值:50 offset 否 Integer 查询起始坐标,即跳过X条数据,仅支持0或limit的整数倍,不满足则向下取整。默认值0 缺省值:0 biz_catalog_id 否 String 所属的业务分层的id
  • 响应示例 状态码: 200 Success,返回data数据是 DimensionVO 数组, 以及总数 { "data" : { "value" : { "records" : [ { "id" : "873251051724242944", "name_en" : "dim_vendor", "dimension_type" : "LOOKUP", "name_ch" : "供应商", "description" : "无", "create_by" : "abc", "update_by" : null, "code_table_id" : "873235088123527168", "code_table" : null, "l1_id" : "873232498044411904", "l2_id" : "873232798230675456", "l3_id" : "873233599258927104", "hierarchies" : [ ], "status" : "PUBLISHED", "create_time" : "2021-08-06T17:07:55+08:00", "update_time" : "2021-08-06T17:36:03+08:00", "approval_info" : { "id" : "873258129008336896", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "873251051724242944", "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-06T17:36:02+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2021-08-06T17:36:03+08:00", "approver" : "abc", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null, "l1" : "城市交通", "l2" : "集团", "l3" : "供应商", "attributes" : [ { "id" : "873251051732631552", "dimension_id" : "873251051724242944", "code_table_field_id" : null, "name_en" : "vendor_id", "name_ch" : "供应商id", "description" : "", "create_by" : "abc", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : null, "is_primary_key" : true, "is_biz_primary" : true, "is_partition_key" : false, "ordinal" : 1, "not_null" : true, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "status" : null, "create_time" : "2021-08-06T17:07:55+08:00", "update_time" : "2021-10-14T10:54:54+08:00", "alias" : null, "self_defined_fields" : null }, { "id" : "873251051732631553", "dimension_id" : "873251051724242944", "code_table_field_id" : null, "name_en" : "vendor_value", "name_ch" : "供应商", "description" : "", "create_by" : "abc", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : null, "is_primary_key" : false, "is_biz_primary" : false, "is_partition_key" : false, "ordinal" : 2, "not_null" : false, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "status" : null, "create_time" : "2021-08-06T17:07:55+08:00", "update_time" : "2021-10-14T10:54:54+08:00", "alias" : null, "self_defined_fields" : null } ], "mappings" : null, "datasource" : { "id" : "873251051745214464", "biz_id" : "873251051724242944", "biz_type" : "DIMENSION", "dw_type" : "DLI", "dw_id" : "2c9080f07b03db8d017b198a4a20002f", "dw_name" : null, "db_name" : "demo_dwr_db", "queue_name" : "dgc_dli_test", "schema" : "" }, "owner" : "abc", "table_type" : "MANAGED", "distribute" : null, "distribute_column" : null, "alias" : "", "self_defined_fields" : null } ] } } }
  • 响应参数 状态码: 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数据是 CatalogVO 数组, 以及总数 { "data" : { "value" : { "records" : [ { "name_ch" : "城市交通", "name_en" : "city_traffic", "description" : "", "qualified_name" : "city_traffic@Business.xxx", "guid" : "f6e674d6-f657-4734-b417-837536c12eee", "code" : null, "alias" : "", "data_owner" : "", "data_owner_list" : "[\"abc\"]", "data_department" : null, "path" : "城市交通", "level" : 1, "ordinal" : 1, "owner" : "abc", "parent_id" : null, "swap_order_id" : null, "id" : "873232498044411904", "qualified_id" : null, "create_by" : "abc", "update_by" : "abc", "create_time" : "2021-08-06T15:54:11+08:00", "update_time" : "2022-08-30T10:59:38+08:00", "self_defined_fields" : [ { "fd_name_ch" : "备注", "fd_name_en" : "ez", "not_null" : false, "fd_value" : "" } ], "children_num" : null, "children" : null } ] } } }
  • URI GET /v3/{project_id}/design/subjects 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 按名称或编码模糊查询 create_by 否 String 按创建者查询 owner 否 String 按负责人查询 status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT 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 parent_id 否 Long 父目录ID,根节点没有此ID,空值为所有,-1为根节点下节点
  • 响应示例 状态码: 200 Success,返回数据是CodeTableFieldVO数组 { "data" : { "value" : [ { "id" : "86936", "code_table_id" : "1006972427986792448", "ordinal" : 1, "name_en" : "id", "name_ch" : "id", "description" : "", "data_type" : "STRING", "domain_type" : null, "data_type_extend" : null, "is_unique_key" : false, "code_table_field_values" : [ { "id" : "18823421", "fd_id" : "86936", "fd_value" : "aaa", "ordinal" : 1, "description" : null } ], "count_field_values" : 1 } ] } }
  • 响应参数 状态码: 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 返回的数据信息 状态码: 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 请求示例 { "to_add" : [ { "id" : "66980", "code_table_id" : "1014919549067366403", "ordinal" : 1, "name_en" : "code", "name_ch" : "编码", "description" : null, "data_type" : "STRING", "domain_type" : null, "data_type_extend" : null, "is_unique_key" : false, "code_table_field_values" : [ { "fd_id" : "66980", "fd_value" : "aaa", "ordinal" : 1 } ], "count_field_values" : null } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 to_add 否 Array of CodeTableFieldVO objects 新增码表属性、属性值列表 to_modify 否 Array of CodeTableFieldVO objects 编辑码表属性值列表 to_remove 否 Array of CodeTableFieldVO objects 删除码表属性id列表 表4 CodeTableFieldVO 参数 是否必选 参数类型 描述 id 否 Long ID code_table_id 否 Long 所属码表id ordinal 是 Integer 序号 name_en 是 String 字段名,英文 最大长度:600 name_ch 是 String 字段名,中文 最大长度:200 description 否 String 描述 最大长度:600 data_type 是 String 字段类型 domain_type 否 String 字段类型所属域 枚举值: NUMBER STRING DATETIME BLOB OTHER data_type_extend 否 String 数据类型扩展字段 最大长度:50 is_unique_key 否 Boolean 是否唯一 缺省值:false code_table_field_values 否 Array of CodeTableFieldValueVO objects 码表属性值 count_field_values 否 Integer 码表属性值总数 表5 CodeTableFieldValueVO 参数 是否必选 参数类型 描述 id 否 Long ID fd_id 否 Long 所属码表属性id fd_value 否 String 码表属性值 ordinal 否 Integer 序号 description 否 String 描述 最大长度:600
  • 响应参数 状态码: 200 表8 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 请求示例 { "entity" : { "attributes" : { "path" : "we", "qualifiedName" : "wewe@Business", "level" : "L3", "name" : "wewe", "nameEng" : "wewe", "alias" : "demo", "description" : "", "dataOwner" : "", "dataOwnerList" : [ "ei_dlg" ], "parent" : { "id" : "864523016602812416" } }, "typeName" : "BusinessCatalog" } }
  • 响应示例 状态码: 200 Success,返回data数据是 entity 详情 { "data" : { "value" : { "alias" : "", "createBy" : "6273052b7ea44765a51304972c2dbaa3", "createTime" : 1661828377965, "dataOwner" : "", "description" : "", "id" : 873232498044411900, "l1" : true, "l2" : false, "l3" : false, "level" : 1, "levelStr" : "1", "nameCh" : "城市交通", "nameEn" : "city_traffic", "ordinal" : "3,", "owner" : "6273052b7ea44765a51304972c2dbaa3", "path" : "城市交通", "qualifiedName" : "city_traffic@Business.xxx", "selfDefinedFields" : null, "tenantId" : "xxx", "updateBy" : "6273052b7ea44765a51304972c2dbaa3", "updateTime" : 1661828378452 } } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 entity 是 CatalogEntityVO object catalog实体 表4 CatalogEntityVO 参数 是否必选 参数类型 描述 typeName 否 String 类型名称,填写“BusinessCatalog”即可 缺省值:BusinessCatalog attributes 是 CatalogAttributeVO object 属性列表 表5 CatalogAttributeVO 参数 是否必选 参数类型 描述 path 是 String 路径 qualifiedName 是 String 名称 level 是 String 主题所属层级 name 是 String 名称 nameEng 是 String 英文名称 alias 否 String 别名 description 是 String 描述 dataOwner 是 String 数据主体 owner 否 String 责任人 dataOwnerList 是 Array of strings 数据主体列表 createTime 否 String 创建时间,时间戳 createBy 否 String 创建人 updateTime 否 String 更新时间,时间戳 updateBy 否 String 更新人 parent 否 parent object 父节点 parentId 否 String 父节点ID l1 否 Boolean 是否为L1层 l2 否 Boolean 是否为L2层 l3 否 Boolean 是否为L3层 ordinal 否 Integer 顺序编号 tenantId 否 String 租户ID self_defined_fields 否 Array of SelfDefinedFieldVO objects 自定义项 表6 parent 参数 是否必选 参数类型 描述 id 否 String 父节点ID 表7 SelfDefinedFieldVO 参数 是否必选 参数类型 描述 fd_name_ch 否 String 自定义项中文名 最大长度:200 fd_name_en 否 String 自定义项英文名 最大长度:200 not_null 否 Boolean 是否必填 fd_value 否 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,返回data数据是 DimensionLogicTableVO 详情 { "data" : { "value" : { "id" : "873258132317642752", "tb_name" : "dim_vendor", "tb_logic_name" : "供应商", "l1_id" : "873232498044411904", "l2_id" : "873232798230675456", "l3_id" : "873233599258927104", "create_by" : "abc", "description" : "无", "dimension_id" : "873251051724242944", "owner" : "abc", "dimension_type" : "LOOKUP", "code_table_id" : "873235088123527168", "code_table" : null, "queue_name" : "dgc_dli_test", "dw_id" : "2c9080f07b03db8d017b198a4a20002f", "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "db_name" : "demo_dwr_db", "tb_id" : "NativeTable-2c9080f07b03db8d017b198a4a20002f-demo_dwr_db-dim_vendor", "schema" : "", "table_type" : "MANAGED", "status" : "PUBLISHED", "tb_guid" : "cea79c27-446e-4529-86e7-d1b371ebb876", "tb_logic_guid" : "048cc0b7-3c0f-40cb-b0e9-e81261117f2d", "dimension_name" : "供应商", "attributes" : [ { "id" : "873258132321837056", "dimension_logic_table_id" : "873258132317642752", "ordinal" : 1, "dimension_attribute_id" : "873251051732631552", "name_en" : "vendor_id", "name_ch" : "供应商id", "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : null, "is_primary_key" : true, "is_biz_primary" : true, "is_partition_key" : false, "not_null" : true, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null, "self_defined_fields" : null }, { "id" : "873258132321837057", "dimension_logic_table_id" : "873258132317642752", "ordinal" : 2, "dimension_attribute_id" : "873251051732631553", "name_en" : "vendor_value", "name_ch" : "供应商", "description" : "", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : null, "is_primary_key" : false, "is_biz_primary" : false, "is_partition_key" : false, "not_null" : false, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null, "self_defined_fields" : null } ], "dw_type" : "DLI", "dw_name" : null, "l1" : "城市交通", "l2" : "集团", "l3" : "供应商", "create_time" : "2021-08-06T17:36:03+08:00", "update_time" : "2021-10-14T10:54:58+08:00", "approval_info" : { "id" : "873258129008336896", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "873251051724242944", "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-06T17:36:02+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2021-08-06T17:36:03+08:00", "approver" : "abc", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null, "physical_table" : "CREATE_SUCCESS", "technical_asset" : "UPDATE_SUCCESS", "business_asset" : "UPDATE_SUCCESS", "meta_data_link" : "UPDATE_SUCCESS", "data_quality" : "UPDATE_SUCCESS", "materialization" : null, "summary_status" : "SUMMARY_SUCCESS", "distribute" : null, "distribute_column" : null, "quality_id" : "873258150667665409", "alias" : "", "self_defined_fields" : null } } }
  • 请求示例 { "entity" : { "attributes" : { "path" : "we", "qualifiedName" : "wewe@Business", "level" : "L3", "name" : "wewe", "nameEng" : "wewe", "alias" : "demo", "description" : "", "dataOwner" : "", "dataOwnerList" : [ "ei_dlg" ], "parent" : { "id" : "864523016602812416" } }, "typeName" : "BusinessCatalog" } }
  • 响应示例 状态码: 200 Success,返回data数据是 entity 详情 { "data" : { "value" : { "alias" : "", "createBy" : "6273052b7ea44765a51304972c2dbaa3", "createTime" : 1661828377965, "dataOwner" : "", "description" : "", "id" : 873232498044411900, "l1" : true, "l2" : false, "l3" : false, "level" : 1, "levelStr" : "1", "nameCh" : "城市交通", "nameEn" : "city_traffic", "ordinal" : "3,", "owner" : "6273052b7ea44765a51304972c2dbaa3", "path" : "城市交通", "qualifiedName" : "city_traffic@Business.xxx", "selfDefinedFields" : null, "tenantId" : "xxx", "updateBy" : "6273052b7ea44765a51304972c2dbaa3", "updateTime" : 1661828378452 } } }
  • 响应参数 状态码: 200 表8 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 404 表12 响应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参数 参数 是否必选 参数类型 描述 entity 是 CatalogEntityVO object catalog实体 表4 CatalogEntityVO 参数 是否必选 参数类型 描述 typeName 否 String 类型名称,填写“BusinessCatalog”即可 缺省值:BusinessCatalog attributes 是 CatalogAttributeVO object 属性列表 表5 CatalogAttributeVO 参数 是否必选 参数类型 描述 path 是 String 路径 qualifiedName 是 String 名称 level 是 String 主题所属层级 name 是 String 名称 nameEng 是 String 英文名称 alias 否 String 别名 description 是 String 描述 dataOwner 是 String 数据主体 owner 否 String 责任人 dataOwnerList 是 Array of strings 数据主体列表 createTime 否 String 创建时间,时间戳 createBy 否 String 创建人 updateTime 否 String 更新时间,时间戳 updateBy 否 String 更新人 parent 否 parent object 父节点 parentId 否 String 父节点ID l1 否 Boolean 是否为L1层 l2 否 Boolean 是否为L2层 l3 否 Boolean 是否为L3层 ordinal 否 Integer 顺序编号 tenantId 否 String 租户ID self_defined_fields 否 Array of SelfDefinedFieldVO objects 自定义项 表6 parent 参数 是否必选 参数类型 描述 id 否 String 父节点ID 表7 SelfDefinedFieldVO 参数 是否必选 参数类型 描述 fd_name_ch 否 String 自定义项中文名 最大长度:200 fd_name_en 否 String 自定义项英文名 最大长度:200 not_null 否 Boolean 是否必填 fd_value 否 String 属性值
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 401 表5 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 403 表6 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息
  • URI GET /v2/{project_id}/design/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 按名称或编码模糊查询 create_by 否 String 按创建者查询 biz_id 否 Long 业务定义id biz_type 否 String 按业务类型查询 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 表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数据是 PublishVersionVO 数组, 以及总数 { "data" : { "value" : { "records" : [ { "id" : "1012308140932370432", "version_name" : "性别_2022-08-25_10-31-08_575", "version_tag" : "性别_2022-08-25_10-31-08_575", "description" : null, "biz_id" : "1012307352952635392", "biz_type" : "CODE_TABLE", "biz_info" : null, "biz_info_vo" : null, "effect_objs" : null, "change_props" : null, "sql_ddl" : null, "physical_table" : null, "technical_asset" : null, "business_asset" : null, "meta_data_link" : null, "data_quality" : null, "dlf_task" : null, "materialization" : null, "publish_to_dlm" : null, "biz_metric" : null, "summary_status" : "SUMMARY_SUCCESS", "is_current_version" : true, "create_time" : "2022-08-25T10:31:09+08:00", "create_by" : "abc" } ] } } }
  • 响应示例 状态码: 200 Success { "data" : { "value" : { "id" : null, "tenant_id" : "xxx", "group_id" : "1014914259626397696", "biz_name" : null, "biz_id" : null, "operation_status" : "SUCCESS", "operation_type" : "FACT_LOGIC_TABLE_REVERSE_DB", "biz_info" : null, "create_by" : "abc", "remark" : null, "total" : 1, "success" : 1, "failed" : 0, "rate" : "1.00", "logs" : null, "groups" : [ { "id" : "1014914260641419264", "tenant_id" : "xxx", "group_id" : "1014914259626397696", "biz_name" : "fact_stroke_order", "biz_id" : null, "operation_status" : "SUCCESS", "operation_type" : "FACT_LOGIC_TABLE_REVERSE_DB", "biz_info" : "", "create_by" : "abc", "remark" : "SKIP | Reverse data: false, Update Exist: false", "total" : 0, "success" : 0, "failed" : 0, "rate" : null, "logs" : null, "groups" : null } ] } } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 401 表5 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 403 表6 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息
  • 响应示例 状态码: 200 Success,返回data数据是 DimensionLogicTableVO 数组, 以及总数 { "data" : { "value" : { "records" : [ { "id" : "873258132317642752", "tb_name" : "dim_vendor", "tb_logic_name" : "供应商", "l1_id" : "873232498044411904", "l2_id" : "873232798230675456", "l3_id" : "873233599258927104", "create_by" : "abc", "description" : "无", "dimension_id" : "873251051724242944", "owner" : "abc", "dimension_type" : "LOOKUP", "code_table_id" : "873235088123527168", "code_table" : null, "queue_name" : "dgc_dli_test", "dw_id" : "2c9080f07b03db8d017b198a4a20002f", "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "db_name" : "demo_dwr_db", "tb_id" : "NativeTable-2c9080f07b03db8d017b198a4a20002f-demo_dwr_db-dim_vendor", "schema" : "", "table_type" : "MANAGED", "status" : "PUBLISHED", "tb_guid" : "cea79c27-446e-4529-86e7-d1b371ebb876", "tb_logic_guid" : "048cc0b7-3c0f-40cb-b0e9-e81261117f2d", "dimension_name" : "供应商", "attributes" : [ { "id" : "873258132321837056", "dimension_logic_table_id" : "873258132317642752", "ordinal" : 1, "dimension_attribute_id" : "873251051732631552", "name_en" : "vendor_id", "name_ch" : "供应商id", "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : null, "is_primary_key" : true, "is_biz_primary" : true, "is_partition_key" : false, "not_null" : true, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null, "self_defined_fields" : null }, { "id" : "873258132321837057", "dimension_logic_table_id" : "873258132317642752", "ordinal" : 2, "dimension_attribute_id" : "873251051732631553", "name_en" : "vendor_value", "name_ch" : "供应商", "description" : "", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : null, "is_primary_key" : false, "is_biz_primary" : false, "is_partition_key" : false, "not_null" : false, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null, "self_defined_fields" : null } ], "dw_type" : "DLI", "dw_name" : null, "l1" : "城市交通", "l2" : "集团", "l3" : "供应商", "create_time" : "2021-08-06T17:36:03+08:00", "update_time" : "2021-10-14T10:54:58+08:00", "approval_info" : { "id" : "873258129008336896", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "873251051724242944", "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-06T17:36:02+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2021-08-06T17:36:03+08:00", "approver" : "abc", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null, "physical_table" : "CREATE_SUCCESS", "technical_asset" : "UPDATE_SUCCESS", "business_asset" : "UPDATE_SUCCESS", "meta_data_link" : "UPDATE_SUCCESS", "data_quality" : "UPDATE_SUCCESS", "materialization" : null, "summary_status" : "SUMMARY_SUCCESS", "distribute" : null, "distribute_column" : null, "quality_id" : "873258150667665409", "alias" : "", "self_defined_fields" : null } ] } } }
  • URI GET /v2/{project_id}/design/dimension-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 l2_id 否 Long 主题域l2 id dimension_id 否 Long 依据维度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 dimension_type 否 String 维度类型 枚举值: COMMON LOOKUP HIERARCHIES
  • 响应参数 状态码: 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 返回的数据信息
共100000条