# 查看表模型详情 - ShowTableModelById #### 功能介绍 通过ID获取模型表详情信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v2/{project_id}/design/table-model/{id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | | id | 是 | String | 实体ID，ID字符串。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | latest | 否 | Boolean | 是否查询最新的。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 使用Token认证时必选。 | | workspace | 是 | String | 工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | | X-Project-Id | 否 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 多project场景采用AK/SK认证的接口请求，则该字段必选。 | | Content-Type | 否 | String | 默认值：application/json;charset=UTF-8 可选，有Body体的情况下必选，没有Body体则无需填写和校验。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [data] object | data，统一的返回结果的最外层数据结构。 | 表5data | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | [TableModelVO] object | value，统一的返回结果的外层数据结构。 | 表6TableModelVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编码，ID字符串。 | | model_id | String | 所属关系建模的模型ID，ID字符串。 | | parent_table_id | String | 父表ID，ID字符串。 | | parent_table_name | String | 父表名称，只读。 | | parent_table_code | String | 父表编码，只读。 | | related_logic_table_id | String | 关联逻辑实体的ID，ID字符串。 | | related_logic_table_name | String | 关联逻辑实体的名称。 | | related_logic_table_model_id | String | 关联逻辑实体的模型ID，ID字符串。 | | related_logic_table_model_name | String | 关联逻辑实体的模型名称。 | | model | [WorkspaceVO] object | 模型信息。 | | data_format | String | 数据格式。 | | obs_bucket | String | obs桶。 | | obs_location | String | 外表路径 | | configs | String | 其他配置。 | | table_type | String | 表类型。 枚举值： - TABLE_MODEL: 关系模型（逻辑模型/物理模型） - AGGREGATION_LOGIC_TABLE: 汇总表 - FACT_LOGIC_TABLE: 事实表 - DIMENSION_LOGIC_TABLE: 维度表 | | owner | String | 负责人。 | | tb_name | String | 表名。 | | 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 | 逻辑实体名。 | | logic_tb_guid | String | 逻辑实体的guid，只读。 | | description | String | 描述。 | | status | String | 实体的发布状态，只读，创建和更新时无需填写。 枚举值： - DRAFT: 草稿 - PUBLISH_DEVELOPING: 发布待审核 - PUBLISHED: 已发布 - OFFLINE_DEVELOPING: 下线待审核 - OFFLINE: 已下线 - REJECT: 已驳回 | | logic_tb_id | String | 逻辑实体的ID，ID字符串。 | | biz_catalog_id | String | 归属的业务分类的id，ID字符串。 | | catalog_path | String | 归属的业务分类的路径 {"l1Id":"","l2Id":"","l3Id":""}。 | | 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。 | | tags | Array of [TagRecordVO] 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 | 数据连接类型，对应表所在的数仓类型，取值可以为DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。 | | dw_name | String | 数据连接名称，只读，创建和更新时无需填写。 | | l1 | String | 主题域分组中文名，只读，创建和更新时无需填写。 | | l2 | String | 主题域中文名，只读，创建和更新时无需填写。 | | l3 | String | 业务对象中文名，只读，创建和更新时无需填写。 | | l1_id | String | 主题域分组ID，只读，ID字符串。 | | l2_id | String | 主题域ID。 | | l3_id | String | 业务对象ID，只读，ID字符串。 | | partition_conf | String | 分区表达式。 | | dlf_task_id | String | DLF作业ID。 | | use_recently_partition | Boolean | 是否使用最新分区。 | | reversed | Boolean | 是否是逆向的。 | | dirty_out_switch | Boolean | 异常数据输出开关。 | | dirty_out_database | String | 异常数据输出库。 | | dirty_out_prefix | String | 异常表前缀。 | | dirty_out_suffix | String | 异常表后缀。 | | quality_owner | String | 质量责任人。 | | quality_id | String | 质量ID，ID字符串。 | | quality_id_extend | String | 质量id，扩展字段。 | | distribute | String | DISTRIBUTE BY \[HASH(column)\|REPLICATION\]。 枚举值： - HASH: 对指定的列进行Hash，通过映射，把数据分布到指定DN - REPLICATION: 表的每一行存在所有数据节点（DN）中，即每个数据节点都有完整的表数据 | | distribute_column | String | DISTRIBUTE BY HASH column. | | is_partition | Boolean | 是否分区表，只读。 | | physical_table | String | 生产环境创建表状态。 | | dev_physical_table | String | 开发环境创建表状态。 | | technical_asset | String | 技术资产同步状态，只读。 | | business_asset | String | 业务资产同步状态，只读。 | | meta_data_link | String | 资产关联状态，只读。 | | data_quality | String | 质量作业状态，只读。 | | dlf_task | String | 数据开发作业状态，只读。 | | summary_status | String | 同步整体状态，只读。 | | dev_version | String | 开发环境版本，只读，ID字符串。 | | prod_version | String | 生产环境版本，只读，ID字符串。 | | dev_version_name | String | 开发环境版本名称，只读。 | | prod_version_name | String | 生产环境版本名称，只读。 | | env_type | String | 开发生产环境类型。 枚举值： - INVALID_TYPE: 无效环境 - DEV_TYPE: 开发环境 - PROD_TYPE: 生产环境 - DEV_PROD_TYPE: 开发生产环境 | | alias | String | 别名。 | | self_defined_fields | Array of [SelfDefinedFieldVO] objects | 自定义项。 | | code | String | 编码 | | has_related_physical_table | Boolean | 是否存在关联物理表。 | | has_related_logic_table | Boolean | 是否存在关联逻辑实体。 | 表7WorkspaceVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编号，ID字符串。 | | name | String | 工作区名字。 | | description | String | 描述。 | | is_physical | Boolean | 是否为物理表。 | | frequent | Boolean | 是否为常用。 | | top | Boolean | 分层治理。 | | level | String | 数据治理分层。 枚举值： - SDI: 贴源数据层 - DWI: 数据整合层 - DWR: 数据报告层 - DM: 数据集市层 | | 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 | 工作区类型枚举。 枚举值： - THIRD_NF: 关系建模 - DIMENSION: 维度建模 | | biz_catalog_ids | String | 关联的业务分层的ID列表 {"l1Ids":\[\],"l2Ids":\[\],"l3Ids":\[\]}。 | | databases | Array of strings | 数据库名称数组。 | | table_model_prefix | String | 模型校验前缀，长度不超过100，数字字母下划线组成，字母开头 | 表8TagRecordVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编码，ID字符串。 | | tag_id | String | 标签ID，ID字符串。 | | tag_name | String | 标签名称。 | | biz_id | String | 实体ID，ID字符串。 | | biz_type | String | 业务实体类型。 枚举值： - AGGREGATION_LOGIC_TABLE: 汇总表 - ATOMIC_INDEX: 原子指标 - ATOMIC_METRIC: 原子指标（新） - BIZ_CATALOG: 流程架构目录 - BIZ_METRIC: 业务指标 - CODE_TABLE: 码表 - COMMON_CONDITION: 通用限定 - COMPOSITE_METRIC: 复合指标（新） - COMPOUND_METRIC: 复合指标 - CONDITION_GROUP: 限定分组 - DEGENERATE_DIMENSION: 退化维度 - DERIVATIVE_INDEX: 衍生指标 - DERIVED_METRIC: 衍生指标（新） - DIMENSION: 维度 - DIMENSION_ATTRIBUTE: 维度属性 - DIMENSION_HIERARCHIES: 维度层级 - DIMENSION_LOGIC_TABLE: 维度表 - DIMENSION_TABLE_ATTRIBUTE: 维度属性 - DIRECTORY: 目录 - FACT_ATTRIBUTE: 事实表属性 - FACT_DIMENSION: 事实表维度 - FACT_LOGIC_TABLE: 事实表 - FACT_MEASURE: 事实表度量 - FUNCTION: 函数 - INFO_ARCH: 信息架构（批量修改主题使用） - MODEL: 模型 - QUALITY_RULE: 质量规则 - SECRECY_LEVEL: 密级 - STANDARD_ELEMENT: 数据标准 - STANDARD_ELEMENT_TEMPLATE: 数据标准模板 - SUBJECT: 主题 - SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性 - SUMMARY_INDEX: 汇总表指标属性 - SUMMARY_TIME: 汇总表时间周期属性 - TABLE_MODEL: 关系模型（逻辑模型/物理模型） - TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型） - TABLE_MODEL_LOGIC: 逻辑实体 - TABLE_TYPE: 表类型 - TAG: 标签 - TIME_CONDITION: 时间限定 | | 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。 | 表9ApprovalVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 审批单ID，ID字符串。 | | tenant_id | String | 项目ID，获取方式参考接口路径参数"project_id"。 | | name_ch | String | 业务中文名。 | | name_en | String | 业务英文名。 | | biz_id | String | 业务ID，ID字符串。 | | biz_type | String | 业务实体类型。 枚举值： - AGGREGATION_LOGIC_TABLE: 汇总表 - ATOMIC_INDEX: 原子指标 - ATOMIC_METRIC: 原子指标（新） - BIZ_CATALOG: 流程架构目录 - BIZ_METRIC: 业务指标 - CODE_TABLE: 码表 - COMMON_CONDITION: 通用限定 - COMPOSITE_METRIC: 复合指标（新） - COMPOUND_METRIC: 复合指标 - CONDITION_GROUP: 限定分组 - DEGENERATE_DIMENSION: 退化维度 - DERIVATIVE_INDEX: 衍生指标 - DERIVED_METRIC: 衍生指标（新） - DIMENSION: 维度 - DIMENSION_ATTRIBUTE: 维度属性 - DIMENSION_HIERARCHIES: 维度层级 - DIMENSION_LOGIC_TABLE: 维度表 - DIMENSION_TABLE_ATTRIBUTE: 维度属性 - DIRECTORY: 目录 - FACT_ATTRIBUTE: 事实表属性 - FACT_DIMENSION: 事实表维度 - FACT_LOGIC_TABLE: 事实表 - FACT_MEASURE: 事实表度量 - FUNCTION: 函数 - INFO_ARCH: 信息架构（批量修改主题使用） - MODEL: 模型 - QUALITY_RULE: 质量规则 - SECRECY_LEVEL: 密级 - STANDARD_ELEMENT: 数据标准 - STANDARD_ELEMENT_TEMPLATE: 数据标准模板 - SUBJECT: 主题 - SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性 - SUMMARY_INDEX: 汇总表指标属性 - SUMMARY_TIME: 汇总表时间周期属性 - TABLE_MODEL: 关系模型（逻辑模型/物理模型） - TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型） - TABLE_MODEL_LOGIC: 逻辑实体 - TABLE_TYPE: 表类型 - TAG: 标签 - TIME_CONDITION: 时间限定 | | biz_info | String | 序列化之后的业务详情，类型是string。 | | biz_info_obj | Object | 业务详情，类型是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 | 目录树。 | 表10TableModelAttributeVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编码，ID字符串。 | | name_en | String | 字段名。 | | name_ch | String | 业务属性。 | | description | String | 描述。 | | obs_location | String | obs路径，子路径。 | | create_by | String | 创建人。 | | update_by | String | 更新人。 | | data_type | String | 字段类型。 枚举值： - BIGINT: 长整型 - STRING: 字符类型 - DATE: 日期类型 | | domain_type | String | 字段类型所属域。 枚举值： - NUMBER: 数字类型 - STRING: 字符类型 - DATETIME: 日期类型 - BLOB: 大对象(BLOB) - OTHER: 其它类型 | | data_type_extend | String | 数据类型扩展字段。 | | is_primary_key | Boolean | 是否主键。 | | is_partition_key | Boolean | 是否分区键。 | | is_foreign_key | Boolean | 是否外键。 | | extend_field | Boolean | 是否继承的属性。 | | not_null | Boolean | 是否不为空。 | | ordinal | Integer | 序号。 | | table_model_id | String | 所属关系建模的模型ID，ID字符串。 | | 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。 | | tags | Array of [TagVO] objects | 表标签，只读。 | | secrecy_levels | Array of [SecrecyLevelVO] objects | 密级 | | stand_row_id | String | 关联的数据标准的ID，ID字符串。 | | stand_row_name | String | 关联的数据标准名称，只读。 | | quality_infos | Array of [QualityInfoVO] objects | 质量信息，只读。 | | alias | String | 别名。 | | self_defined_fields | Array of [SelfDefinedFieldVO] objects | 自定义项。 | | code | String | 逻辑属性编码 | | related_logic_attr_id | String | 关联逻辑属性ID，ID字符串。 | | related_logic_attr_name | String | 关联逻辑实体属性中文名称。 | | related_logic_attr_name_en | String | 关联逻辑实体属性英文名称。 | 表11TagVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编码，ID字符串。 | | name | String | 标签名。 | | 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 | 业务版本管理，只读。 | 表12SecrecyLevelVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 密级ID，ID字符串。 | | 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 | 业务版本管理，只读。 | 表13BizVersionManageVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | ID信息，ID字符串。 | | biz_type | String | 业务实体类型。 枚举值： - AGGREGATION_LOGIC_TABLE: 汇总表 - ATOMIC_INDEX: 原子指标 - ATOMIC_METRIC: 原子指标（新） - BIZ_CATALOG: 流程架构目录 - BIZ_METRIC: 业务指标 - CODE_TABLE: 码表 - COMMON_CONDITION: 通用限定 - COMPOSITE_METRIC: 复合指标（新） - COMPOUND_METRIC: 复合指标 - CONDITION_GROUP: 限定分组 - DEGENERATE_DIMENSION: 退化维度 - DERIVATIVE_INDEX: 衍生指标 - DERIVED_METRIC: 衍生指标（新） - DIMENSION: 维度 - DIMENSION_ATTRIBUTE: 维度属性 - DIMENSION_HIERARCHIES: 维度层级 - DIMENSION_LOGIC_TABLE: 维度表 - DIMENSION_TABLE_ATTRIBUTE: 维度属性 - DIRECTORY: 目录 - FACT_ATTRIBUTE: 事实表属性 - FACT_DIMENSION: 事实表维度 - FACT_LOGIC_TABLE: 事实表 - FACT_MEASURE: 事实表度量 - FUNCTION: 函数 - INFO_ARCH: 信息架构（批量修改主题使用） - MODEL: 模型 - QUALITY_RULE: 质量规则 - SECRECY_LEVEL: 密级 - STANDARD_ELEMENT: 数据标准 - STANDARD_ELEMENT_TEMPLATE: 数据标准模板 - SUBJECT: 主题 - SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性 - SUMMARY_INDEX: 汇总表指标属性 - SUMMARY_TIME: 汇总表时间周期属性 - TABLE_MODEL: 关系模型（逻辑模型/物理模型） - TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型） - TABLE_MODEL_LOGIC: 逻辑实体 - TABLE_TYPE: 表类型 - TAG: 标签 - TIME_CONDITION: 时间限定 | | biz_id | String | 业务ID，ID字符串。 | | biz_info | String | 业务对象信息。 | | status | String | 实体的发布状态，只读，创建和更新时无需填写。 枚举值： - DRAFT: 草稿 - PUBLISH_DEVELOPING: 发布待审核 - PUBLISHED: 已发布 - OFFLINE_DEVELOPING: 下线待审核 - OFFLINE: 已下线 - REJECT: 已驳回 | | 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。 | 表14QualityInfoVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编码ID，ID字符串。 | | table_id | String | 表ID，只读，ID字符串。 | | attr_id | String | 属性ID，只读，ID字符串。 | | biz_type | String | 业务实体类型。 枚举值： - AGGREGATION_LOGIC_TABLE: 汇总表 - ATOMIC_INDEX: 原子指标 - ATOMIC_METRIC: 原子指标（新） - BIZ_CATALOG: 流程架构目录 - BIZ_METRIC: 业务指标 - CODE_TABLE: 码表 - COMMON_CONDITION: 通用限定 - COMPOSITE_METRIC: 复合指标（新） - COMPOUND_METRIC: 复合指标 - CONDITION_GROUP: 限定分组 - DEGENERATE_DIMENSION: 退化维度 - DERIVATIVE_INDEX: 衍生指标 - DERIVED_METRIC: 衍生指标（新） - DIMENSION: 维度 - DIMENSION_ATTRIBUTE: 维度属性 - DIMENSION_HIERARCHIES: 维度层级 - DIMENSION_LOGIC_TABLE: 维度表 - DIMENSION_TABLE_ATTRIBUTE: 维度属性 - DIRECTORY: 目录 - FACT_ATTRIBUTE: 事实表属性 - FACT_DIMENSION: 事实表维度 - FACT_LOGIC_TABLE: 事实表 - FACT_MEASURE: 事实表度量 - FUNCTION: 函数 - INFO_ARCH: 信息架构（批量修改主题使用） - MODEL: 模型 - QUALITY_RULE: 质量规则 - SECRECY_LEVEL: 密级 - STANDARD_ELEMENT: 数据标准 - STANDARD_ELEMENT_TEMPLATE: 数据标准模板 - SUBJECT: 主题 - SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性 - SUMMARY_INDEX: 汇总表指标属性 - SUMMARY_TIME: 汇总表时间周期属性 - TABLE_MODEL: 关系模型（逻辑模型/物理模型） - TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型） - TABLE_MODEL_LOGIC: 逻辑实体 - TABLE_TYPE: 表类型 - TAG: 标签 - TIME_CONDITION: 时间限定 | | data_quality_id | String | 质量ID，ID字符串。 | | 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。 | 表15TableMappingVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编码，ID字符串。 | | name | String | 名称。 | | description | String | 描述。 | | target_table_id | String | 目的表ID，ID字符串。 | | src_model_id | String | 来源表在关系建模中的模型ID，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 | 创建时间，格式遵循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 | 更新人。 | 表16TableMappingDetailVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编码，ID字符串。 | | mapping_id | String | 名称。 | | target_attr_id | String | 目的字段ID，ID字符串。 | | target_attr_name | String | 目的字段排序。 | | src_table_ids | String | 源表ID。 | | src_table_names | Array of strings | 源表名称数组，只读。 | | src_table_db_names | Array of strings | 源表db名称数组，只读。 | | src_table_model_ids | Array of strings | 源表在关系建模中的模型ID数组，只读，ID字符串。 | | src_table_id_list | Array of strings | 源表ID数组，只读，ID字符串。 | | src_attr_ids | String | 源表字段ID。 | | src_attr_names | Array of strings | 源表字段名称数组，只读。 | | src_attr_id_list | Array of strings | 源表字段ID数组，只读，ID字符串。 | | remark | 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。 | | create_by | String | 创建人。 | | update_by | String | 更新人。 | | target_attr | Object | 目标属性。 | 表17MappingSourceTableVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | table1_id | String | 表1ID，ID字符串。 | | table2_id | String | 表2ID，ID字符串。 | | table1_name | String | 表1名称。 | | table2_name | String | 表2名称。 | | join_type | String | 关联类型。 枚举值： - LEFT: 左外连接 - RIGHT: 右外连接 - INNER: 内连接 - FULL: 全连接 | | join_fields | Array of [MappingJoinFieldVO] objects | on条件。 | 表18MappingJoinFieldVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | field1_id | String | 属性1ID，ID字符串。 | | field2_id | String | 属性2ID，ID字符串。 | | field1_name | String | 属性1名称。 | | field2_name | String | 属性2名称。 | 表19MappingSourceFieldVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | target_field_id | String | 目标字段ID，当前表的某个字段，ID字符串。 | | target_field_name | String | 目标字段编码。 | | field_ids | String | 来源字段ID，多个ID以逗号分隔。 | | transform_expression | String | 转换表达式。 | | field_names | Array of strings | 来源字段名称列表。 | | changed | Boolean | 字段是否发生变化。 | 表20RelationVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编码，ID字符串。 | | source_table_id | String | 源表ID，ID字符串。 | | target_table_id | String | 目标表ID，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 | 创建时间，只读，格式遵循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。 | | mappings | Array of [RelationMappingVO] objects | 表属性信息，只读。 | 表21RelationMappingVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编码，ID字符串。 | | relation_id | String | 关系ID，ID字符串。 | | source_field_id | String | 源字段ID，ID字符串。 | | target_field_id | String | 目标字段ID，ID字符串。 | | source_field_name | String | 源表名称。 | | target_field_name | 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。 | 表22SelfDefinedFieldVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | fd_name_ch | String | 自定义项中文名。 | | fd_name_en | String | 自定义项英文名。 | | not_null | Boolean | 是否必填。 | | fd_value | String | 属性值。 | **状态码：400** 表23响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：401** 表24响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：403** 表25响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | #### 请求示例 通过ID获取模型表详情信息。 ``` GET https://{endpoint}/v2/{project_id}/design/table-model/1231932180633112576 ``` #### 响应示例 **状态码：200** Success，返回data数据是TableModelVO详情。 ``` { "data" : { "value" : { "id" : "1231932180633112576", "model_id" : "1208730797675311104", "parent_table_id" : null, "parent_table_name" : null, "parent_table_code" : null, "related_logic_table_id" : null, "related_logic_table_name" : null, "related_logic_table_model_id" : null, "related_logic_table_model_name" : null, "model" : { "id" : "1208730797675311104", "name" : "xingneng2", "description" : "", "is_physical" : true, "frequent" : false, "top" : false, "level" : null, "dw_type" : "MRS_HIVE", "create_time" : "2024-02-18T11:04:39+08:00", "update_time" : "2024-02-18T11:04:39+08:00", "create_by" : "test_user", "update_by" : "test_user", "type" : "THIRD_NF", "biz_catalog_ids" : null, "databases" : null, "table_model_prefix" : "" }, "data_format" : "Parquet", "obs_bucket" : null, "obs_location" : null, "configs" : "{}", "table_type" : "HIVE_TABLE", "owner" : "", "tb_name" : "test_update_table_model", "dw_id" : "0fafdd43a342436e87e42d7217d26679", "db_name" : null, "queue_name" : null, "schema" : null, "extend_info" : "{\"dirtyOutDatabase\":\"\",\"dirtyOutPrefix\":\"\",\"dirtyOutSuffix\":\"\",\"dirtyOutSwitch\":\"false\"}", "tb_guid" : null, "tb_id" : null, "logic_tb_name" : "test_update_table_model", "logic_tb_guid" : null, "description" : "无", "status" : "DRAFT", "logic_tb_id" : null, "biz_catalog_id" : "958408897973161984", "catalog_path" : "tesy", "create_by" : "test_user", "update_by" : "test_user", "create_time" : "2024-04-22T11:38:40+08:00", "update_time" : "2024-04-22T11:39:22+08:00", "tags" : [ ], "approval_info" : null, "new_biz" : null, "attributes" : [ { "id" : "1231932180754747392", "name_en" : "col_a", "name_ch" : "col_a", "description" : "", "obs_location" : null, "create_by" : null, "update_by" : null, "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : "", "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : false, "extend_field" : false, "not_null" : false, "ordinal" : 1, "table_model_id" : null, "create_time" : "2024-04-22T11:38:40+08:00", "update_time" : "2024-04-22T11:39:23+08:00", "tags" : [ ], "secrecy_levels" : [ ], "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : [ ], "alias" : "", "self_defined_fields" : [ { "fd_name_ch" : "苏", "fd_name_en" : "SDSDFD", "not_null" : false, "fd_value" : "" }, { "fd_name_ch" : "test", "fd_name_en" : "test", "not_null" : false, "fd_value" : "" } ], "code" : "", "related_logic_attr_id" : null, "related_logic_attr_name" : null, "related_logic_attr_name_en" : null }, { "id" : "1231932180754747393", "name_en" : "col_b", "name_ch" : "col_b", "description" : "", "obs_location" : null, "create_by" : null, "update_by" : null, "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : "", "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : false, "extend_field" : false, "not_null" : false, "ordinal" : 2, "table_model_id" : null, "create_time" : "2024-04-22T11:38:40+08:00", "update_time" : "2024-04-22T11:39:23+08:00", "tags" : [ ], "secrecy_levels" : [ ], "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : [ ], "alias" : "", "self_defined_fields" : [ { "fd_name_ch" : "苏", "fd_name_en" : "SDSDFD", "not_null" : false, "fd_value" : "" }, { "fd_name_ch" : "test", "fd_name_en" : "test", "not_null" : false, "fd_value" : "" } ], "code" : "", "related_logic_attr_id" : null, "related_logic_attr_name" : null, "related_logic_attr_name_en" : null } ], "mappings" : null, "relations" : [ ], "dw_type" : "MRS_HIVE", "dw_name" : "MRS_Hive", "l1" : "tesy", "l2" : null, "l3" : null, "l1_id" : "958408897973161984", "l2_id" : null, "l3_id" : null, "partition_conf" : null, "dlf_task_id" : null, "use_recently_partition" : false, "reversed" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "quality_owner" : null, "quality_id" : null, "distribute" : null, "distribute_column" : null, "is_partition" : false, "physical_table" : "NO_NEED", "dev_physical_table" : "NO_NEED", "technical_asset" : "NO_NEED", "business_asset" : "NO_NEED", "meta_data_link" : "NO_NEED", "data_quality" : "NO_NEED", "summary_status" : "NO_NEED", "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "INVALID_TYPE", "alias" : null, "self_defined_fields" : null, "code" : null, "has_related_physical_table" : false, "has_related_logic_table" : false } } } ``` **状态码：400** BadRequest ``` { "error_code" : "DS.60xx", "error_msg" : "The user request is illegal." } ``` **状态码：401** Unauthorized ``` { "error_code" : "DS.60xx", "error_msg" : "User authentication failed." } ``` **状态码：403** Forbidden ``` { "error_code" : "DS.60xx", "error_msg" : "The user does not have permission to call this API." } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ShowTableModelByIdSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("")) .build(); ShowTableModelByIdRequest request = new ShowTableModelByIdRequest(); request.withId("{id}"); try { ShowTableModelByIdResponse response = client.showTableModelById(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("")) \ .build() try: request = ShowTableModelByIdRequest() request.id = "{id}" response = client.show_table_model_by_id(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dataartsstudio.NewDataArtsStudioClient(hcClient) request := &model.ShowTableModelByIdRequest{} request.Id = "{id}" response, err := client.ShowTableModelById(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/sdk?api=ShowTableModelById)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success，返回data数据是TableModelVO详情。 | | 400 | BadRequest | | 401 | Unauthorized | | 403 | Forbidden |