更新时间:2024-12-02 GMT+08:00
分享

比较版本信息

功能介绍

通过两个版本id,比较两者差异。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/design/versions/compare

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

表2 Query参数

参数

是否必选

参数类型

描述

ids

Array of strings

实体ID数组,ID字符串。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

data

data object

data,统一的返回结果的最外层数据结构。

表4 data

参数

参数类型

描述

value

PublishVersionVO object

CatalogVO信息。

表5 PublishVersionVO

参数

参数类型

描述

id

String

版本ID,ID字符串。

version_name

String

版本名称。

version_tag

String

版本标记,只读。

description

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

业务详情,只读。

biz_info_vo

Object

业务对象。

effect_objs

String

影响信息,只读。

change_props

String

变化信息,只读。

sql_ddl

String

SQL脚本,只读。

physical_table

String

生产环境创建表状态

dev_physical_table

String

开发环境创建表状态

technical_asset

String

技术资产同步状态,只读。

business_asset

String

业务资产同步状态,只读。

meta_data_link

String

资产关联状态,只读。

data_quality

String

质量作业状态,只读。

dlf_task

String

数据开发作业状态,只读。

materialization

String

码表数值落库状态,只读。

publish_to_dlm

String

DLM API生成状态,只读。

biz_metric

String

业务指标同步状态,只读。

summary_status

String

统一统计状态,只读。

is_current_version

Boolean

是否为当前版本,只读。

create_time

String

创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

create_by

String

创建人,只读。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

请求示例

比对版本ID为1295786824106741760与1301676931971940352之间的差异。

POST https://{endpoint}/v1/{project_id}/design/versions/compare?ids=1295786824106741760&&ids=1301676931971940352

{ }

响应示例

状态码: 200

Success,返回data数据是 PublishVersionVO 详情。

{
  "data" : {
    "value" : {
      "id" : "1301676931971940352",
      "version_name" : "pd_test_2024-10-31_22-39-24_572",
      "version_tag" : "pd_test_2024-10-31_22-39-24_572",
      "description" : null,
      "biz_id" : "1295696904545603584",
      "biz_type" : "TABLE_MODEL",
      "biz_info" : "{\"versionName\":null,\"versionTag\":null,\"versionId\":null,\"createBy\":\"0833a573fe80d5401f6dc010a775569a\",\"updateBy\":\"0833a573fe80d5401f6dc010a775569a\",\"createTime\":1728959815000,\"updateTime\":1730385564000,\"l3Id\":\"1089989054919065600\",\"l2Id\":null,\"alias\":null,\"encoding\":\"LE003444\",\"prefix\":\"LE\",\"codeNum\":null,\"extendInfo\":\"{\\\"dirtyOutDatabase\\\":\\\"\\\",\\\"dirtyOutPrefix\\\":\\\"\\\",\\\"dirtyOutSuffix\\\":\\\"\\\",\\\"dirtyOutSwitch\\\":\\\"false\\\"}\",\"id\":\"1295696904545603584\",\"description\":\"无\",\"tenantId\":\"0833a5737480d53b2f25c010dc1a7b88-workspace-eeb055e69c624311b6b9cfee89a4ec70\",\"status\":\"PUBLISHED\",\"tbName\":\"pd_test\",\"tbLogicName\":\"pd_test\",\"owner\":\"\",\"queueName\":\"default\",\"schema\":null,\"dbName\":\"bi\",\"distribute\":null,\"distributeColumn\":null,\"compression\":null,\"obsLocation\":null,\"preCombineField\":null,\"dwId\":\"8259af52bd294f98920ebce75a426391\",\"dwName\":null,\"dwType\":\"DLI\",\"physicalTable\":\"UPDATE_SUCCESS\",\"devPhysicalTable\":\"NO_NEED\",\"technicalAsset\":\"NO_NEED\",\"businessAsset\":\"NO_NEED\",\"metaDataLink\":\"NO_NEED\",\"dataQuality\":\"UPDATE_FAILED\",\"dlfTask\":\"NO_NEED\",\"summaryStatus\":\"SUMMARY_FAILED\",\"materialization\":null,\"publishToDlm\":null,\"envType\":\"PROD_TYPE\",\"devVersion\":null,\"prodVersion\":\"1299388171930447872\",\"apiId\":null,\"tbLogicGuid\":\"33c30a2c-5f23-4bb5-a9c5-c1c0c8a7d609\",\"tbGuid\":null,\"tbId\":\"NativeTable-8259af52bd294f98920ebce75a426391-pd_test\",\"partitionConf\":null,\"qualityOwner\":null,\"qualityId\":\"1295789728175833089\",\"qualityIdExtend\":null,\"useRecentlyPartition\":false,\"reversed\":null,\"dirtyOutSwitch\":false,\"dirtyOutDatabase\":\"\",\"dirtyOutPrefix\":\"\",\"dirtyOutSuffix\":\"\",\"dlfTaskId\":null,\"modelId\":\"1295338804126908416\",\"model\":null,\"selfDefinedFields\":null,\"scheduleTime\":null,\"parentTableId\":null,\"parentTableName\":null,\"parentTableCode\":null,\"relatedLogicTableId\":\"1230888997367193600\",\"relatedLogicTableName\":\"pd_test\",\"relatedLogicTableModelId\":\"1148908032844009472\",\"relatedLogicTableModelName\":\"test_import\",\"logicTbName\":\"pd_test\",\"logicTbGuid\":\"33c30a2c-5f23-4bb5-a9c5-c1c0c8a7d609\",\"logicTbId\":null,\"bizCatalogId\":\"1089989054919065600\",\"bizCatalogGuid\":null,\"catalogPath\":null,\"secretType\":\"PUBLIC\",\"tableType\":\"MANAGED\",\"dataFormat\":\"Parquet\",\"configs\":\"{}\",\"obsBucket\":null,\"approval\":null,\"sourceType\":0,\"tags\":[],\"secrecyLevels\":null,\"attributes\":[{\"versionName\":null,\"versionTag\":null,\"versionId\":null,\"createBy\":\"0833a573fe80d5401f6dc010a775569a\",\"updateBy\":\"0833a573fe80d5401f6dc010a775569a\",\"createTime\":1728959815000,\"updateTime\":1730385565000,\"l3Id\":null,\"l2Id\":null,\"alias\":\"\",\"encoding\":\"LP070256\",\"prefix\":\"LP\",\"codeNum\":null,\"id\":\"1295696904545603585\",\"nameEn\":\"id\",\"nameCh\":\"id\",\"description\":\"\",\"obsLocation\":null,\"dataType\":\"STRING\",\"isPrimaryKey\":true,\"isPartitionKey\":false,\"isForeignKey\":false,\"extendField\":false,\"ordinal\":1,\"tableModelId\":null,\"relatedLogicAttrId\":\"1230888997920841728\",\"relatedLogicAttrName\":\"id\",\"relatedLogicAttrNameEn\":\"id\",\"standRowId\":\"1294696939622932481\",\"standRowName\":\"1.1,avavvqav\",\"tags\":[],\"secrecyLevels\":[{\"versionName\":null,\"versionTag\":null,\"versionId\":null,\"createBy\":\"ei_dayu_y00321344_01\",\"updateBy\":\"ei_dayu_y00321344_01\",\"createTime\":1730385564000,\"updateTime\":1730385564000,\"l3Id\":null,\"l2Id\":null,\"alias\":null,\"encoding\":null,\"prefix\":null,\"codeNum\":null,\"id\":\"20356\",\"secrecyLevelId\":\"1140704811168288768\",\"bizId\":\"1295696904545603585\",\"secrecyLevelName\":\"zcy_admin_10\",\"uuid\":\"\",\"slevel\":0,\"description\":null,\"bizType\":\"TABLE_MODEL\",\"tenantId\":\"0833a5737480d53b2f25c010dc1a7b88-workspace-eeb055e69c624311b6b9cfee89a4ec70\",\"nameEn\":null,\"nameCh\":null,\"status\":null,\"lastL2Id\":null}],\"dataTypeExtend\":\"\",\"domainType\":\"STRING\",\"qualityInfos\":[],\"standElementValues\":null,\"selfDefinedFields\":[{\"fdNameCh\":\"隐私等级\",\"fdNameEn\":\"SecretLevel\",\"notNull\":false,\"fdValue\":\"aa\",\"fdName\":\"隐私等级\",\"tenantId\":null,\"nameEn\":null,\"nameCh\":null,\"createBy\":null,\"l3Id\":null,\"id\":null,\"status\":null},{\"fdNameCh\":\"同义词\",\"fdNameEn\":\"sameWord\",\"notNull\":false,\"fdValue\":\"bb\",\"fdName\":\"同义词\",\"tenantId\":null,\"nameEn\":null,\"nameCh\":null,\"createBy\":null,\"l3Id\":null,\"id\":null,\"status\":null}],\"notNull\":true,\"code\":\"LP070256\",\"bizCatalogId\":null,\"tenantId\":null,\"primaryKey\":true,\"partitionKey\":false,\"status\":null,\"lastL2Id\":null}],\"relations\":[],\"reverseRelations\":[],\"mappings\":null,\"isPartition\":false,\"code\":\"LE003444\",\"nameEn\":\"pd_test\",\"nameCh\":\"pd_test\",\"tagList\":[],\"secrecyLevelList\":[],\"lastL2Id\":null}",
      "biz_info_vo" : {
        "id" : "1295696904545603584",
        "model_id" : "1295338804126908416",
        "parent_table_id" : null,
        "parent_table_name" : null,
        "parent_table_code" : null,
        "related_logic_table_id" : "1230888997367193600",
        "related_logic_table_name" : "pd_test",
        "related_logic_table_model_id" : "1148908032844009472",
        "related_logic_table_model_name" : "test_import",
        "model" : {
          "id" : "1295338804126908416",
          "name" : "10啊v擦",
          "description" : "",
          "is_physical" : true,
          "frequent" : false,
          "top" : true,
          "dw_type" : null,
          "create_time" : 1.728874437E9,
          "update_time" : 1.728874437E9,
          "create_by" : "ei_dayu_y00321344_01",
          "update_by" : "ei_dayu_y00321344_01",
          "type" : "THIRD_NF",
          "layer_id" : "1255490378069700608",
          "layer" : {
            "id" : "1255490378069700608",
            "level" : 1,
            "name" : "ODS",
            "type" : "THIRD_NF",
            "description" : null,
            "is_default" : true,
            "disabled_customized_field_ids" : [ "1254806436282773504" ]
          },
          "level" : null,
          "biz_catalog_ids" : null,
          "databases" : null,
          "table_model_prefix" : "",
          "dimension_prefix" : null,
          "is_default" : false,
          "has_permissions" : null
        },
        "data_format" : "Parquet",
        "obs_bucket" : null,
        "obs_location" : null,
        "configs" : "{}",
        "table_type" : "MANAGED",
        "owner" : "",
        "tb_name" : "pd_test",
        "dw_id" : "8259af52bd294f98920ebce75a426391",
        "db_name" : "bi",
        "queue_name" : "default",
        "schema" : null,
        "extend_info" : "{\"dirtyOutDatabase\":\"\",\"dirtyOutPrefix\":\"\",\"dirtyOutSuffix\":\"\",\"dirtyOutSwitch\":\"false\"}",
        "tb_guid" : null,
        "tb_id" : "NativeTable-8259af52bd294f98920ebce75a426391-pd_test",
        "logic_tb_name" : "pd_test",
        "logic_tb_guid" : "33c30a2c-5f23-4bb5-a9c5-c1c0c8a7d609",
        "description" : "无",
        "status" : "PUBLISHED",
        "logic_tb_id" : null,
        "biz_catalog_id" : "1089989054919065600",
        "catalog_path" : "lxy4/lxy_3",
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "create_time" : 1.728959815E9,
        "update_time" : 1.730385564E9,
        "tags" : [ ],
        "attributes" : [ {
          "id" : "1295696904545603585",
          "name_en" : "id",
          "name_ch" : "id",
          "description" : "",
          "obs_location" : null,
          "create_by" : "ei_dayu_y00321344_01",
          "update_by" : "ei_dayu_y00321344_01",
          "data_type" : "STRING",
          "domain_type" : "STRING",
          "data_type_extend" : "",
          "is_primary_key" : true,
          "is_partition_key" : false,
          "is_foreign_key" : false,
          "extend_field" : false,
          "not_null" : true,
          "ordinal" : 1,
          "table_model_id" : null,
          "create_time" : 1.728959815E9,
          "update_time" : 1.730385565E9,
          "tags" : [ ],
          "secrecy_levels" : [ {
            "id" : "20356",
            "secrecyLevel_id" : "1140704811168288768",
            "secrecyLevel_name" : "zcy_admin_10",
            "uuid" : "",
            "slevel" : 0,
            "description" : null,
            "biz_id" : "1295696904545603585",
            "biz_type" : "TABLE_MODEL",
            "create_by" : "ei_dayu_y00321344_01",
            "update_by" : "ei_dayu_y00321344_01",
            "create_time" : 1.730385564E9,
            "update_time" : 1.730385564E9
          } ],
          "stand_row_id" : "1294696939622932481",
          "stand_row_name" : "1.1,avavvqav",
          "quality_infos" : [ ],
          "alias" : "",
          "self_defined_fields" : [ {
            "fd_name_ch" : "隐私等级",
            "fd_name_en" : "SecretLevel",
            "not_null" : false,
            "fd_value" : "aa"
          }, {
            "fd_name_ch" : "同义词",
            "fd_name_en" : "sameWord",
            "not_null" : false,
            "fd_value" : "bb"
          } ],
          "code" : "LP070256",
          "related_logic_attr_id" : "1230888997920841728",
          "related_logic_attr_name" : "id",
          "related_logic_attr_name_en" : "id"
        } ],
        "mappings" : null,
        "relations" : [ ],
        "dw_type" : "DLI",
        "dw_name" : "dli",
        "l1" : "lxy4",
        "l2" : "lxy_3",
        "l3" : null,
        "l1_id" : "1088851391579066368",
        "l2_id" : "1089989054919065600",
        "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" : "1295789728175833089",
        "quality_id_extend" : null,
        "distribute" : null,
        "distribute_column" : null,
        "compression" : null,
        "pre_combine_field" : null,
        "is_partition" : false,
        "physical_table" : "UPDATE_SUCCESS",
        "dev_physical_table" : "NO_NEED",
        "technical_asset" : "NO_NEED",
        "business_asset" : "NO_NEED",
        "meta_data_link" : "NO_NEED",
        "data_quality" : "UPDATE_FAILED",
        "summary_status" : "SUMMARY_FAILED",
        "dev_version" : null,
        "prod_version" : "1299388171930447872",
        "dev_version_name" : null,
        "prod_version_name" : null,
        "env_type" : "PROD_TYPE",
        "alias" : null,
        "self_defined_fields" : null,
        "code" : "LE003444",
        "has_related_physical_table" : false,
        "has_related_logic_table" : false
      },
      "effect_objs" : null,
      "change_props" : "基本信息:\n队列:CCdefault@CC\n数据库:CCbi@CC\n\n\n\n表字段:\n\nid : 数据标准:CC1.1,avavvqav@CC .",
      "sql_ddl" : null,
      "physical_table" : "UPDATE_SUCCESS",
      "technical_asset" : "CREATE_SUCCESS",
      "business_asset" : "NO_NEED",
      "meta_data_link" : "UPDATE_SUCCESS",
      "data_quality" : "UPDATE_FAILED",
      "dlf_task" : "NO_NEED",
      "materialization" : null,
      "publish_to_dlm" : null,
      "biz_metric" : "NO_NEED",
      "summary_status" : "SUMMARY_FAILED",
      "is_current_version" : false,
      "create_time" : "2024-10-31T22:39:25+08:00",
      "create_by" : "ei_dayu_y00321344_01"
    }
  }
}

状态码: 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数据是 PublishVersionVO 详情。

400

BadRequest

401

Unauthorized

403

Forbidden

相关文档