数据治理中心 DATAARTS STUDIO-创建表模型:请求参数

时间:2023-11-29 09:26:28

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM Token

workspace

String

DataArts Studio 工作空间ID

表3 请求Body参数

参数

是否必选

参数类型

描述

id

Long

编码

model_id

Long

模型id

parent_table_id

Long

父表id

parent_table_name

String

父表名称

parent_table_code

String

父表编码

model

WorkspaceVO object

模型

data_format

String

数据格式

最大长度:100

obs_bucket

String

obs桶

最大长度:200

obs_location

String

obs路径

最大长度:2000

configs

String

其他配置

最大长度:1024

table_type

String

表类型

owner

String

最大长度:100

tb_name

String

表名

最大长度:400

dw_id

String

数据连接id

db_name

String

数据库名

queue_name

String

dli数据连接执行sql所需的队列,数据连接类型为 DLI 时必须

schema

String

DWS类型需要

extend_info

String

扩展信息

tb_guid

String

表物化后的guid

tb_id

String

数据表id

logic_tb_name

String

逻辑实体名

最大长度:200

logic_tb_guid

String

逻辑实体的guid

description

String

描述

最大长度:600

status

String

业务状态

枚举值:

  • DRAFT

  • PUBLISH_DEVELOPING

  • PUBLISHED

  • OFFLINE_DEVELOPING

  • OFFLINE

  • REJECT

logic_tb_id

Long

逻辑实体的id

biz_catalog_id

Long

归属的业务分类的id

catalog_path

String

归属的业务分类的路径 {"l1Id":"","l2Id":"","l3Id":""}

create_by

String

创建人

update_by

String

更新人

create_time

String

创建时间

update_time

String

更新时间

tags

Array of TagVO objects

表标签

approval_info

ApprovalVO object

审批信息

new_biz

BizVersionManageVO object

业务版本管理.

attributes

Array of TableModelAttributeVO objects

表属性信息

mappings

Array of TableMappingVO objects

表映射信息

relations

Array of RelationVO objects

关系

dw_type

String

数据连接类型

dw_name

String

数据连接名称

l1

String

主题域分组中文名

l2

String

主题域中文名

l3

String

业务对象中文名

l1_id

Long

主题域分组id

l2_id

String

主题域id

l3_id

Long

业务对象id

partition_conf

String

分区表达式

dlf_task_id

String

DLF 作业 ID

use_recently_partition

Boolean

是否使用最新分区

缺省值:false

reversed

Boolean

是否是逆向的

缺省值:false

dirty_out_switch

Boolean

异常数据输出开关

缺省值:false

dirty_out_database

String

异常数据输出库

dirty_out_prefix

String

异常表前缀

dirty_out_suffix

String

异常表后缀

quality_owner

String

质量责任人

quality_id

Long

质量id

distribute

String

DISTRIBUTE BY [HASH(column)|REPLICATION]

枚举值:

  • HASH

  • REPLICATION

distribute_column

String

DISTRIBUTE BY HASH column

is_partition

Boolean

是否分区表

缺省值:false

physical_table

String

创建表状态

枚举值:

  • NO_NEED

  • CREATE_SUC CES S

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

technical_asset

String

技术资产同步状态

枚举值:

  • NO_NEED

  • CREATE_SUCCESS

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

business_asset

String

业务资产同步状态

枚举值:

  • NO_NEED

  • CREATE_SUCCESS

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

meta_data_link

String

资产关联状态

枚举值:

  • NO_NEED

  • CREATE_SUCCESS

  • CREATE_FAILED

  • UPDATE_SUCCESS

  • UPDATE_FAILED

  • SUMMARY_SUCCESS

  • SUMMARY_FAILED

  • RUNNING

  • OFFLINE

data_quality

String

质量作业状态

枚举值:

  • NO_NEED

  • CREATE_SUCCESS

  • 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

alias

String

别名

self_defined_fields

Array of SelfDefinedFieldVO objects

自定义项

表4 WorkspaceVO

参数

是否必选

参数类型

描述

id

Long

编号

name

String

工作区名字

最大长度:250

description

String

最大长度:600

is_physical

Boolean

是否为物理表

缺省值:true

frequent

Boolean

是否为常用

缺省值:true

top

Boolean

分层治理

缺省值:true

level

String

数据治理 分层

枚举值:

  • SDI

  • DWI

  • DWR

  • DM

dw_type

String

数据连接类型

create_time

String

创建时间

update_time

String

更新时间

create_by

String

创建人

update_by

String

更新人

type

String

工作区类型枚举

枚举值:

  • THIRD_NF

  • DIMENSION

biz_catalog_ids

String

关联的业务分层的id列表 {"l1Ids":[],"l2Ids":[],"l3Ids":[]}

databases

Array of strings

数据库名称数组

表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_ 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

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 TableModelAttributeVO

参数

是否必选

参数类型

描述

id

Long

编码

name_en

String

字段名

最大长度:600

name_ch

String

业务属性

最大长度:200

description

String

最大长度:600

obs_location

String

obs路径,子路径

最大长度:600

create_by

String

创建人

update_by

String

更新人

data_type

String

字段类型

domain_type

String

字段类型所属域

枚举值:

  • NUMBER

  • STRING

  • DATETIME

  • BLOB

  • OTHER

data_type_extend

String

数据类型扩展字段

最大长度:50

is_primary_key

Boolean

是否主键

缺省值:false

is_partition_key

Boolean

是否分区键

缺省值:false

is_foreign_key

Boolean

是否外键

缺省值:false

extend_field

Boolean

是否继承的属性

缺省值:false

not_null

Boolean

是否不为空

缺省值:false

ordinal

Integer

序号

table_model_id

Long

所属表模型id

create_time

String

创建时间

update_time

String

更新时间

tags

Array of TagVO objects

表标签

stand_row_id

Long

关联的数据标准的id

stand_row_name

String

最大长度:600

quality_infos

Array of QualityInfoVO objects

质量信息

alias

String

别名

self_defined_fields

Array of SelfDefinedFieldVO objects

自定义项

表7 TagVO

参数

是否必选

参数类型

描述

id

Long

编码

name

String

标签名

最大长度:250

description

String

最大长度:600

create_by

String

创建人

update_by

String

更新人

create_time

String

创建时间

update_time

String

更新时间

new_biz

BizVersionManageVO object

业务版本管理.

表8 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

更新时间

表9 QualityInfoVO

参数

是否必选

参数类型

描述

id

Long

编码

table_id

Long

表id

attr_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

data_quality_id

Long

质量id

show_control

Integer

是否要显示 正则表达式

data_quality_name

String

质量名称

alert_conf

String

告警配置

expression

String

正则相关校验规则中正则配置

extend_info

String

扩展信息

from_standard

Boolean

是否来源于数据标准质量配置

缺省值:false

result_description

String

结果说明

create_by

String

创建人

update_by

String

更新人

create_time

String

创建时间

update_time

String

更新时间

表10 TableMappingVO

参数

是否必选

参数类型

描述

id

Long

编码

name

String

名称

description

String

最大长度:600

target_table_id

Long

目的表id

src_model_id

Long

来源表所属模型id

src_model_name

String

来源模型名称

view_text

String

采集的视图来源,dws视图逆向使用

target_table_name

String

目的表名称

details

Array of TableMappingDetailVO objects

详情

source_tables

Array of MappingSourceTableVO objects

映射的表信息

source_fields

Array of MappingSourceFieldVO objects

映射的字段信息

create_time

String

创建时间

update_time

String

更新时间

create_by

String

创建人

update_by

String

更新人

表11 TableMappingDetailVO

参数

是否必选

参数类型

描述

id

Long

编码

mapping_id

String

名称

target_attr_id

Long

目的字段id

target_attr_name

String

目的字段排序

src_table_ids

String

源表id, 通过,join

src_table_names

Array of strings

源表名称数组

src_table_db_names

Array of strings

源表db名称数组

src_table_model_ids

Array of longs

源表模型id数组

src_table_id_list

Array of longs

源表id数组

src_attr_ids

String

源表字段id, 通过,join

src_attr_names

Array of strings

源表字段名称数组

src_attr_id_list

Array of longs

源表字段id数组

remark

String

备注

create_time

String

创建时间

update_time

String

更新时间

create_by

String

创建人

update_by

String

更新人

target_attr

Object

目标属性

表12 MappingSourceTableVO

参数

是否必选

参数类型

描述

table1_id

Long

表id

table2_id

Long

表id

缺省值:0

table1_name

String

表1名称

table2_name

String

表2名称

join_type

String

关联类型,左外连接,右外连接,内连接,全连接

缺省值:LEFT

枚举值:

  • LEFT

  • RIGHT

  • INNER

  • FULL

join_fields

Array of MappingJoinFieldVO objects

on条件

表13 MappingJoinFieldVO

参数

是否必选

参数类型

描述

field1_id

Long

属性id

field2_id

Long

属性id

field1_name

String

名称

field2_name

String

名称

表14 MappingSourceFieldVO

参数

是否必选

参数类型

描述

target_field_id

Long

目标字段ID,当前表的某个字段

target_field_name

String

目标字段编码

field_ids

String

来源字段id,多个id以逗号分隔

transform_expression

String

转换表达式

field_names

Array of strings

来源字段名称列表

changed

Boolean

字段是否发生变化

表15 RelationVO

参数

是否必选

参数类型

描述

id

Long

编码

source_table_id

Long

源表id

target_table_id

Long

目标表id

name

String

关系名称

source_table_name

String

源表名称

target_table_name

String

目的表名称

role

String

角色

tenant_id

String

租户id

source_type

String

关系类型

枚举值:

  • ONE

  • ZERO_OR_ONE

  • ZERO_OR_N

  • ONE_OR_N

target_type

String

关系类型

枚举值:

  • ONE

  • ZERO_OR_ONE

  • ZERO_OR_N

  • ONE_OR_N

create_by

String

创建人

update_by

String

更新人

create_time

String

创建时间

update_time

String

更新时间

mappings

Array of RelationMappingVO objects

表属性信息

表16 RelationMappingVO

参数

是否必选

参数类型

描述

id

Long

编码

relation_id

Long

关系id

source_field_id

Long

源字段id

target_field_id

Long

目标字段id

source_field_name

String

源表名称

target_field_name

String

目的表名称

create_by

String

创建人

update_by

String

更新人

create_time

String

创建时间

update_time

String

更新时间

表17 SelfDefinedFieldVO

参数

是否必选

参数类型

描述

fd_name_ch

String

自定义项中文名

最大长度:200

fd_name_en

String

自定义项英文名

最大长度:200

not_null

Boolean

是否必填

fd_value

String

属性值

support.huaweicloud.com/api-dataartsstudio/CreateTableModel.html