查找维度表
功能介绍
通过中英文名称、创建者、审核人、状态、修改时间分页查找维度表信息。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/design/dimension-logic-tables
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
按名称或编码模糊查询。 |
create_by |
否 |
String |
按创建者查询。 |
approver |
否 |
String |
按审核人查询。 |
owner |
否 |
String |
按负责人查询。 |
status |
否 |
String |
业务状态。 枚举值:
|
sync_status |
否 |
String |
同步状态枚举。 枚举值:
|
sync_key |
否 |
Array of strings |
同步任务类型枚举。 枚举值:
|
l2_id |
否 |
String |
主题域l2的ID,填写String类型替代Long类型。 |
dimension_id |
否 |
String |
依据维度ID查维度属性,填写String类型替代Long类型。 |
begin_time |
否 |
String |
时间过滤左边界,与end_time一起使用,只支持时间范围过滤,单边过滤无效。格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
end_time |
否 |
String |
时间过滤右边界,与begin_time一起使用只支持时间范围过滤,单边过滤无效。格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
limit |
否 |
Integer |
每页查询条数,即查询Y条数据。默认值50,取值范围[1,100]。 |
offset |
否 |
Integer |
查询起始坐标,即跳过X条数据,仅支持0或limit的整数倍,不满足则向下取整,默认值0。 |
biz_catalog_id |
否 |
String |
所属的业务分层的ID。 |
dimension_type |
否 |
String |
维度类型。 枚举值:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 使用Token认证时必选。 |
workspace |
是 |
String |
工作空间ID,获取方法请参见实例ID和工作空间ID。 |
X-Project-Id |
否 |
String |
项目ID,获取方法请参见项目ID和账号ID。 多project场景采用AK/SK认证的接口请求,则该字段必选。 |
Content-Type |
否 |
String |
默认值:application/json;charset=UTF-8 可选,有Body体的情况下必选,没有Body体则无需填写和校验。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
data,统一的返回结果的最外层数据结构。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
表ID |
tb_name |
String |
表名称。 |
tb_logic_name |
String |
逻辑实体名。 |
l1_id |
String |
主题域分组ID,只读,填写String类型替代Long类型。 |
l2_id |
String |
主题域ID。 |
l3_id |
String |
业务对象ID,填写String类型替代Long类型。 |
create_by |
String |
创建人。 |
description |
String |
描述。 |
dimension_id |
String |
所属维度ID,填写String类型替代Long类型。 |
owner |
String |
资产责任人。 |
dimension_type |
String |
维度类型。 枚举值:
|
code_table_id |
String |
引用码表ID,填写String类型替代Long类型。 |
code_table |
CodeTableVO object |
引用码表,只读。 |
queue_name |
String |
dli数据连接执行sql所需的队列,数据连接类型为DLI时必须。 |
dw_id |
String |
数据连接ID。 |
reversed |
Boolean |
是否是逆向的。 |
partition_conf |
String |
分区表达式。 |
dirty_out_switch |
Boolean |
异常数据输出开关。 |
dirty_out_database |
String |
异常数据输出库。 |
dirty_out_prefix |
String |
异常表前缀。 |
dirty_out_suffix |
String |
异常表后缀。 |
db_name |
String |
库名。 |
tb_id |
String |
数据表ID,只读。 |
schema |
String |
DWS类型需要。 |
table_type |
String |
表类型。 |
status |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
tb_guid |
String |
表发布后,创建的数据目录技术资产guid,只读,创建和更新时无需填写。 |
tb_logic_guid |
String |
表发布后,创建的数据目录业务资产guid,只读,创建和更新时无需填写。 |
dimension_name |
String |
关联维度名称,只读。 |
attributes |
Array of DimensionLogicTableAttributeVO objects |
字段属性。 |
dw_type |
String |
数据连接类型,对应表所在的数仓类型,取值可以为DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。 |
dw_name |
String |
数据连接名称,只读,创建和更新时无需填写。 |
l1 |
String |
主题域分组中文名,只读,创建和更新时无需填写。 |
l2 |
String |
主题域中文名,只读,创建和更新时无需填写。 |
l3 |
String |
业务对象中文名,只读,创建和更新时无需填写。 |
create_time |
String |
创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
update_time |
String |
更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
approval_info |
ApprovalVO object |
审批信息,只读参数。业务对象最近一次的审批信息,包括审批的业务详情、审核人信息、审核时间等。 |
new_biz |
BizVersionManageVO object |
业务版本管理,只读。 |
physical_table |
String |
生产环境创建表状态 |
dev_physical_table |
String |
开发环境创建表状态 |
technical_asset |
String |
技术资产同步状态,只读。 |
business_asset |
String |
业务资产同步状态,只读。 |
meta_data_link |
String |
资产关联状态,只读。 |
data_quality |
String |
质量作业状态,只读。 |
materialization |
String |
数值落库状态,只读。 |
summary_status |
String |
同步整体状态,只读。 |
distribute |
String |
DISTRIBUTE BY [HASH(column)|REPLICATION]。 枚举值:
|
distribute_column |
String |
DISTRIBUTE BY HASH column. |
quality_id |
String |
质量ID,填写String类型替代Long类型。 |
alias |
String |
别名。 |
self_defined_fields |
Array of SelfDefinedFieldVO objects |
自定义项。 |
obs_location |
String |
外表路径 |
configs |
String |
其他配置 |
dev_version |
String |
开发环境版本,填写String类型替代Long类型。 |
prod_version |
String |
生产环境版本,填写String类型替代Long类型。 |
dev_version_name |
String |
开发环境版本名称。 |
prod_version_name |
String |
生产环境版本名称。 |
env_type |
String |
开发生产环境类型。 枚举值:
|
model_id |
Long |
所属模型ID。 |
model |
WorkspaceVO object |
模型信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
码表ID,填写String类型替代Long类型。 |
name_en |
String |
表名称,英文名。 |
name_ch |
String |
表名称,中文名。 |
tb_version |
Integer |
表版本。 |
directory_id |
String |
目录ID,填写String类型替代Long类型。 |
directory_path |
String |
目录树。 |
description |
String |
描述。 |
create_by |
String |
创建人。 |
status |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
create_time |
String |
创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
update_time |
String |
更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
approval_info |
ApprovalVO object |
审批信息,只读参数。业务对象最近一次的审批信息,包括审批的业务详情、审核人信息、审核时间等。 |
new_biz |
BizVersionManageVO object |
业务版本管理,只读。 |
code_table_fields |
Array of CodeTableFieldVO objects |
码表属性信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
码表字段ID,填写String类型替代Long类型。 |
code_table_id |
String |
所属码表ID,填写String类型替代Long类型。 |
ordinal |
Integer |
序号。 |
name_en |
String |
字段名,英文。 |
name_ch |
String |
字段名,中文。 |
description |
String |
描述。 |
data_type |
String |
字段类型。 |
domain_type |
String |
字段类型所属域。 枚举值:
|
data_type_extend |
String |
数据类型扩展字段。 |
is_unique_key |
Boolean |
是否唯一。 |
code_table_field_values |
Array of CodeTableFieldValueVO objects |
码表属性值。 |
count_field_values |
Integer |
码表属性值总数。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
码表字段ID,填写String类型替代Long类型。 |
fd_id |
String |
所属码表属性ID,填写String类型替代Long类型。 |
fd_value |
String |
码表属性值。 |
ordinal |
Integer |
序号。 |
description |
String |
描述。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
维度表ID,填写String类型替代Long类型。 |
dimension_logic_table_id |
String |
所属维表ID。 |
ordinal |
Integer |
序号 |
dimension_attribute_id |
String |
维度属性ID,填写String类型替代Long类型。 |
name_en |
String |
字段名,只读。 |
name_ch |
String |
业务属性,只读。 |
description |
String |
描述,只读。 |
data_type |
String |
字段类型。 |
domain_type |
String |
字段类型所属域。 枚举值:
|
data_type_extend |
String |
数据类型扩展字段。 |
is_primary_key |
Boolean |
是否主键,只读。 |
is_biz_primary |
Boolean |
是否业务主键。 |
is_partition_key |
Boolean |
是否主键分区,只读。 |
not_null |
Boolean |
是否不为空。 |
stand_row_id |
String |
关联的数据标准的ID,填写String类型替代Long类型。 |
stand_row_name |
String |
关联的数据标准名称,只读。 |
quality_infos |
Array of QualityInfoVO objects |
质量信息,只读。 |
alias |
String |
别名。 |
self_defined_fields |
Array of SelfDefinedFieldVO objects |
自定义项。 |
secrecy_levels |
Array of SecrecyLevelVO objects |
密级 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
编码ID,填写String类型替代Long类型。 |
table_id |
String |
表ID,只读,填写String类型替代Long类型。 |
attr_id |
String |
属性ID,只读,填写String类型替代Long类型。 |
biz_type |
String |
业务实体类型。 枚举值:
|
data_quality_id |
String |
质量ID,填写String类型替代Long类型。 |
show_control |
Integer |
是否要显示正则表达式。 |
data_quality_name |
String |
质量名称。 |
alert_conf |
String |
告警配置。 |
expression |
String |
正则相关校验规则中正则配置。 |
extend_info |
String |
扩展信息。 |
from_standard |
Boolean |
是否来源于数据标准质量配置,只读。 |
result_description |
String |
结果说明。 |
create_by |
String |
创建人,只读。 |
update_by |
String |
更新人,只读。 |
create_time |
String |
创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
update_time |
String |
更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
密级ID,填写String类型替代Long类型。 |
uuid |
String |
数据安全主键。 |
name |
String |
密级名。 |
slevel |
Integer |
密级等级。 |
description |
String |
密级描述。 |
create_by |
String |
创建人。 |
update_by |
String |
更新人。 |
create_time |
String |
创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
update_time |
String |
更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
new_biz |
BizVersionManageVO object |
业务版本管理,只读。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
审批单ID,填写String类型替代Long类型。 |
tenant_id |
String |
项目ID,获取方式参考接口路径参数“project_id”。 |
name_ch |
String |
业务中文名。 |
name_en |
String |
业务英文名。 |
biz_id |
String |
业务ID,填写String类型替代Long类型。 |
biz_type |
String |
业务实体类型。 枚举值:
|
biz_info |
String |
序列化之后的业务详情,类型是string。 |
biz_info_obj |
Object |
业务详情,类型是object。 |
biz_version |
Integer |
业务版本。 |
biz_status |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
approval_status |
String |
业务审批状态,只读。 枚举值:
|
approval_type |
String |
业务审核类型。 枚举值:
|
submit_time |
String |
提交时间。 |
create_by |
String |
创建者。 |
l1 |
String |
主题域分组中文名,只读,创建和更新时无需填写。 |
l2 |
String |
主题域中文名,只读,创建和更新时无需填写。 |
l3 |
String |
业务对象中文名,只读,创建和更新时无需填写。 |
approval_time |
String |
审核时间。 |
approver |
String |
审核人。 |
|
String |
审核人邮箱。 |
msg |
String |
审核信息。 |
directory_path |
String |
目录树。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
ID信息,填写String类型替代Long类型。 |
biz_type |
String |
业务实体类型。 枚举值:
|
biz_id |
String |
业务ID,填写String类型替代Long类型。 |
biz_info |
String |
业务对象信息。 |
status |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
biz_version |
Integer |
业务版本,只读。 |
create_time |
String |
创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
update_time |
String |
更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
参数 |
参数类型 |
描述 |
---|---|---|
fd_name_ch |
String |
自定义项中文名。 |
fd_name_en |
String |
自定义项英文名。 |
not_null |
Boolean |
是否必填。 |
fd_value |
String |
属性值。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
编号,填写String类型替代Long类型。 |
name |
String |
工作区名字。 |
description |
String |
描述。 |
is_physical |
Boolean |
是否为物理表。 |
frequent |
Boolean |
是否为常用。 |
top |
Boolean |
分层治理。 |
level |
String |
数据治理分层。 枚举值:
|
dw_type |
String |
数据连接类型,对应表所在的数仓类型,取值可以为DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。 |
create_time |
String |
创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
update_time |
String |
更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
create_by |
String |
创建人。 |
update_by |
String |
更新人。 |
type |
String |
工作区类型枚举。 枚举值:
|
biz_catalog_ids |
String |
关联的业务分层的ID列表 {"l1Ids":[],"l2Ids":[],"l3Ids":[]}。 |
databases |
Array of strings |
数据库名称数组。 |
table_model_prefix |
String |
模型校验前缀,长度不超过100,数字字母下划线组成,字母开头 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
请求示例
根据查询条件分页查找维度表。
GET https://{endpoint}/v2/{project_id}/design/dimension-logic-tables?offset=1&limit=10
响应示例
状态码: 200
Success,返回data数据是DimensionLogicTableVO数组,以及总数。
{ "data" : { "value" : { "total" : 1, "records" : [ { "id" : "1222930979413499904", "tb_name" : "dim_test_czh_0328", "tb_logic_name" : "test_czh_0328", "l1_id" : "1194966710038474752", "l2_id" : null, "l3_id" : null, "create_by" : "test_uesr", "description" : "无", "dimension_id" : "1222930977286987776", "owner" : "afcaca", "dimension_type" : "COMMON", "code_table_id" : null, "code_table" : null, "queue_name" : "default", "dw_id" : "8259af52bd294f98920ebce75a426391", "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "db_name" : "bi", "tb_id" : null, "schema" : "", "table_type" : "MANAGED", "status" : "PUBLISHED", "tb_guid" : null, "tb_logic_guid" : "712edcdd-3bba-4077-b182-4a1f17e5bcd8", "dimension_name" : "test_czh_0328", "attributes" : [ { "id" : "1222930979442860032", "dimension_logic_table_id" : "1222930979413499904", "ordinal" : 1, "dimension_attribute_id" : "1222930977370873856", "name_en" : "dim_test_czh_0328_key", "name_ch" : "test_czh_0328", "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : null, "is_primary_key" : true, "is_biz_primary" : false, "is_partition_key" : false, "not_null" : false, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ { "fd_name_ch" : "aa", "fd_name_en" : "aa", "not_null" : false, "fd_value" : "" }, { "fd_name_ch" : "bb", "fd_name_en" : "bb", "not_null" : false, "fd_value" : "" } ], "secrecy_levels" : [ ] }, { "id" : "1222930979442860033", "dimension_logic_table_id" : "1222930979413499904", "ordinal" : 2, "dimension_attribute_id" : "1222930977370873857", "name_en" : "aaa", "name_ch" : "aaa", "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "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" : "", "self_defined_fields" : [ { "fd_name_ch" : "aa", "fd_name_en" : "aa", "not_null" : false, "fd_value" : "" }, { "fd_name_ch" : "bb", "fd_name_en" : "bb", "not_null" : false, "fd_value" : "" } ], "secrecy_levels" : [ ] }, { "id" : "1222930979442860034", "dimension_logic_table_id" : "1222930979413499904", "ordinal" : 3, "dimension_attribute_id" : "1222930977370873858", "name_en" : "bbb", "name_ch" : "bbb", "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "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" : "", "self_defined_fields" : [ { "fd_name_ch" : "aa", "fd_name_en" : "aa", "not_null" : false, "fd_value" : "" }, { "fd_name_ch" : "bb", "fd_name_en" : "bb", "not_null" : false, "fd_value" : "" } ], "secrecy_levels" : [ ] } ], "dw_type" : "DWS", "dw_name" : null, "l1" : "test_czh_catalog", "l2" : null, "l3" : null, "create_time" : "2024-03-28T15:31:06+08:00", "update_time" : "2024-03-28T15:31:10+08:00", "approval_info" : { "id" : "1222930978226511872", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "1222930977286987776", "biz_type" : null, "biz_info" : null, "biz_info_obj" : null, "biz_version" : 0, "biz_status" : "PUBLISHED", "approval_status" : "APPROVED", "approval_type" : null, "submit_time" : "2024-03-28T15:31:06+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2024-03-28T15:31:06+08:00", "approver" : "test_uesr", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null, "physical_table" : "CREATE_FAILED", "dev_physical_table" : "NO_NEED", "technical_asset" : "CREATE_FAILED", "business_asset" : "CREATE_SUCCESS", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "NO_NEED", "materialization" : null, "summary_status" : "SUMMARY_FAILED", "distribute" : null, "distribute_column" : null, "obs_location" : null, "quality_id" : null, "alias" : "", "configs" : "{}", "self_defined_fields" : [ { "fd_name_ch" : "自定义项1", "fd_name_en" : "selfDefine1", "not_null" : false, "fd_value" : "" }, { "fd_name_ch" : "自定义项2", "fd_name_en" : "selfDefine2", "not_null" : true, "fd_value" : "adada" } ], "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "PROD_TYPE" } ] } } }
状态码: 400
{ "error_code" : "DS.60xx", "error_msg" : "The user request is illegal." }
状态码: 401
{ "error_code" : "DS.60xx", "error_msg" : "User authentication failed." }
状态码: 403
{ "error_code" : "DS.60xx", "error_msg" : "The user does not have permission to call this API." }
状态码
状态码 |
描述 |
---|---|
200 |
Success,返回data数据是DimensionLogicTableVO数组,以及总数。 |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |