全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：QueryPublicModelEngine - 查询数据建模引擎的信息

    文档中心

    大数据开发治理平台 DataWorks：QueryPublicModelEngine - 查询数据建模引擎的信息

    更新时间：Nov 15, 2024

    使用FML语句查询数据建模引擎的信息。

    接口说明

    • 每次调用该接口均需使用 FML 语句请求获取查询信息。
    • 除了数仓分层、业务过程和数据域查询外，其他引擎信息查询均可使用分页查询方式。您可以在 FML 语句结尾增加 offset num limit num 语句，表示查询信息时的偏移量及每次返回的页数。目前偏移量取值仅支持为页数的倍数。
    • 每次调用该接口时，最多返回 1000 条数据。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    当前API暂无授权信息透出。

    请求参数

    名称类型必填描述示例值
    Textstring是

    输入查询引擎信息的 FML 语句，详情请参见使用 FML 语句配置并管理数据表。 当前仅支持 show 语句。

    		show dim tables
    ProjectIdstring是

    DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间管理页面获取 ID。

    		1234

    返回参数

    名称类型描述示例值
    object

    是调用 FML 语句查询返回的结果。

    RequestIdstring

    本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。

    		4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4
    ReturnValuearray<object>

    是通过 FML 语句查询返回的列表信息。

    DetailDTOobject

    返回通过 FML 语句查询的数据建模引擎信息的结果。

    		[{ "gmtModified": 最后修改时间,"code": "表名","creatorId": "创建人ID","creatorName": "创建人名称","modifierId": "修改人ID","gmtCreate": 创建时间,"type": 表类型,"ownerId": "负责人ID","uuid": "系统ID","businessUnitUuid": "业务板块ID","detailType": "表二级类型","ownerName": "负责人名称","name": "表显示名","modifierName": "最后修改人名称","businessProcessUuid": "业务过程ID" }]

    返回结果说明

    查询数仓分层使用的 FML 语句如下。

    show layers;
    输出参数

    参数名参数类型示例值描述信息
    codeStringdws数仓分层编码
    englishNameStringdws数仓分层英文名
    nameString汇总层数仓分层中文名
    ownerIdString0123456负责人 ID
    ownerNameString甲乙丙丁负责人名称
    descriptionString汇总层描述备注
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询数据域使用的 FML 语句如下。

    show domains;
    输出参数

    参数名参数类型示例值描述信息
    codeStringmember数据域编码
    englishNameStringmember数据域英文名
    nameString会员数据域中文名
    ownerIdString0123456负责人 ID
    ownerNameString甲乙丙丁负责人名称
    businessUnitCodeStringbu-123456业务板块编码
    descriptionString会员域备注备注
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseIdID
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseIdID
    modifierNameString甲乙丙丁修改人名称

    查询业务过程使用的 FML 语句如下。

    • 无条件列表查询：show business_processes;
    • 根据 code 查询业务过程：show business_processes where code='bp-code';
    • 根据数据域查询业务过程：show business_processes where data_domain='dm-code';

    输出参数

    参数名参数类型示例值描述信息
    codeStringbp-123456业务过程编码
    englishNameStringpay业务过程英文名
    nameString付款业务过程中文名
    dataDomainCodeStringtrade所属数据域编码
    dataDomainNameString交易所属数据域中文名
    dataDomainUuidStringdm-123456所属数据域 UUID
    ownerIdString0123456负责人 BaseId
    ownerNameString甲乙丙丁负责人名称
    descriptionString付款备注
    sourceInteger2创建来源。可取值如下：
    1：系统创建
    2：用户创建
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdStringcreatorId创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询业务分类使用的 FML 语句如下。

     show business_categories;
 show business_categories where code='code';
 show business_categories where keyword='keyword';
 show business_categories where uuid='uuid';

    输出参数

    参数名参数类型示例值描述信息
    categoryDetailDirectoryDetailDTO{"uuid": "cate_uuid", "code": "trd", "name": "交易"}业务分类详细信息
    nameString电商目录名称
    detailTypeStringDICT目录子类型
    parentUuidStringdy-123456父级目录 UUID
    descriptionString描述信息目录描述
    codeStringind业务分类 code
    dataDomainsList[{"uuid": "domain1", "code": "trd", "name": "交易域"}]业务分类下挂靠数据域
    ownerIdString0123456负责人 BaseId
    ownerNameString甲乙丙丁负责人名称
    businessUnitCodeStringbu-123456业务板块编码
    descriptionString描述信息目录描述
    categoryPathStringtm.ind业务分类 path

    查询数据集市使用的 FML 语句如下。

    show markets; 输出参数

    参数名参数类型示例值描述信息
    categoryDetailDirectoryDetailDTO{"uuid": "cate_uuid", "code": "trd", "name": "交易"}数据集市详细信息
    nameString电商目录名称
    detailTypeStringDICT目录子类型
    parentUuidStringdy-123456父级目录 UUID
    descriptionString描述信息目录描述
    codeStringind业务分类 code
    subDetailTypeStringcommon目录子类型细分类型
    auditDTOListList[{"baseId":"123","showName":"test"}]审核人员列表
    codeStringmember数据域编码
    englishNameStringmember数据域英文名
    nameString会员数据域中文名
    ownerIdString0123456负责人 BaseId
    ownerNameString甲乙丙丁负责人名称
    businessUnitCodeStringbu-123456业务板块编码
    descriptionString会员域备注备注
    auditDTOListList[{"baseId":"123","showName":"test"}]审核人员列表
    categoryPathStringtm.ind业务分类 path

    查询主题域使用的 FML 语句如下。

    show subjects; 输出参数

    参数名参数类型示例值描述信息
    categoryDetailDirectoryDetailDTO{"uuid": "cate_uuid", "code": "trd", "name": "交易"}主题详细信息
    nameString电商目录名称
    detailTypeStringDICT目录子类型
    parentUuidStringdy-123456父级目录 UUID
    descriptionString描述信息目录描述
    codeStringind业务分类 code
    subDetailTypeStringcommon目录子类型细分类型
    auditDTOListList[{"baseId":"123","showName":"test"}]审核人员列表
    codeStringmember数据域编码
    englishNameStringmember数据域英文名
    nameString会员数据域中文名
    ownerIdString0123456负责人 BaseId
    ownerNameString甲乙丙丁负责人名称
    businessUnitCodeStringbu-123456业务板块编码
    descriptionString会员域备注备注
    auditDTOListList[{"baseId":"123","showName":"test"}]审核人员列表
    categoryPathStringtm.ind业务分类 path

    查询数据标准集使用的 FML 语句如下。

    show dict groups; 输出参数

    参数名参数类型示例值描述信息
    nameString电商目录名称
    detailTypeStringDICT目录子类型
    parentUuidStringdy-123456父级目录 UUID
    descriptionString描述信息目录描述
    codeStringind业务分类 code
    uuidListobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询数据标准使用的 FML 语句如下。

    show dicts; 输出参数

    参数名参数类型示例值描述信息
    codeStringshop_type英文缩写
    englishNameStringshop type英文名称
    nameString店铺类型中文名称
    noStringSN00001标准编号
    dataTypeStringSTRING数据类型
    lengthInteger10列长度
    numericalPrecisionInteger2列精度
    notNullBooleanfalse是否不为空
    defaultValueString旗舰店默认值
    parentNoStringSN0001父级标准编号
    parentNameString店铺父级标准名称
    codeTableNoStringshop_type引用码表编号
    codeTableNameString店铺类型码表引用码表名称
    codeTableUuidStringtb-0001引用码表 UUID
    directoryUuidString所属目录 UUID所属目录 UUID
    directoryNameString店铺目录所属目录名称
    descriptionStringremark备注
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询标准代码使用的 FML 语句如下。

    show code tables; 输出参数

    参数名参数类型示例值描述信息
    codeStringshop_type代码编码
    nameString店铺类型代码名称
    extendNameStringshop type英文名称
    descriptionStringremark描述
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询度量单位组使用的 FML 语句如下。

    show measure_unit groups; 输出参数

    参数名参数类型示例值描述信息
    nameString电商目录名称
    detailTypeStringDICT目录子类型
    parentUuidStringdy-123456父级目录 UUID
    descriptionString描述信息目录描述
    codeStringind分类 code
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询度量单位使用的 FML 语句如下。

    show measure_units; 输出参数

    参数名参数类型示例值描述信息
    codeStringyuan英文缩写
    englishNameStringRMB英文名称
    nameString元列中文名称
    directoryUuidStringdi-0001单位分组 UUID
    directoryNameString货币单位分组名称
    descriptionStringremark备注
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询标准代码内容使用的 FML 语句如下。

    show codes from code_table; 输出参数

    参数名参数类型示例值描述信息
    codeContentString0code 内容值
    extendNameContentStringfemale扩展标准代码名称
    nameContentString女性标准代码名称
    descriptionStringremark标准代码描述
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询命名词典使用的 FML 语句如下。

    show naming dicts; 输出参数

    参数名参数类型示例值描述信息
    codeStringshop英文缩写
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    extendNameStringshop英文名称
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称
    nameString店铺中文名称
    ownerIdString0123456负责人 BaseId
    ownerNameString甲乙丙丁负责人名称
    uuidStringobj-123456对象唯一标识

    查询表信息使用的 FML 语句如下。

    show tables; 输出参数

    参数名参数类型示例值描述信息
    codeStringdim_shop表编码
    nameString店铺维度表表中文名
    typeInteger1表类型。取值如下：
    0：事实表
    1：维度表
    3：汇总表
    4：应用表
    5：贴源表
    6：维度
    detailTypeStringnormal表具体类型。可取值如下：
    普通维度
    枚举维度
    事务事实
    businessProcessUuidStringbp-123456业务过程 UUID
    businessUnitUuidStringbu-123456业务板块 UUID
    dataWarehouseLayerUuidStringly-123456数仓层 UUID
    businessCategoryUuidStringbc-123456业务分类 UUID
    ownerIdString0123456负责人 BaseId
    ownerNameString甲乙丙丁负责人名称
    descriptionString店铺表备注备注
    configStringjson 字符串拓展属性配置
    lifeCycleInteger365表生命周期
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询维度表使用的 FML 语句如下。

    show dim tables;
    输出参数

    参数名参数类型示例值描述信息
    codeStringdim_shop表编码
    nameString店铺维度表表中文名
    typeInteger1表类型。可取值如下：
    0：事实表
    1：维度表
    detailTypeStringnormal表具体类型。可取值如下：
    普通维度
    枚举维度
    事务事实
    businessProcessUuidStringbp-123456业务过程 UUID
    businessUnitUuidStringbu-123456业务板块 UUID
    dataWarehouseLayerUuidStringly-123456数仓层 UUID
    businessCategoryUuidStringbc-123456业务分类 UUID
    ownerIdString0123456负责人 BaseId
    ownerNameString甲乙丙丁负责人名称
    descriptionString店铺表备注备注
    configStringjson 字符串拓展属性配置
    lifeCycleInteger365表生命周期
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询事实表信息使用的 FML 语句如下。

    show fact tables; 输出参数

    参数名参数类型示例值描述信息
    codeStringdim_shop表编码
    nameString店铺维度表表中文名
    typeInteger1表类型。可取值如下：
    0：事实表
    1：维度表
    detailTypeStringnormal表具体类型。可取值如下：
    普通维度
    枚举维度
    事务事实
    businessProcessUuidStringbp-123456业务过程 UUID
    businessUnitUuidStringbu-123456业务板块 UUID
    dataWarehouseLayerUuidStringly-123456数仓层 UUID
    businessCategoryUuidStringbc-123456业务分类 UUID
    ownerIdString0123456负责人 BaseId
    ownerNameString甲乙丙丁负责人名称
    descriptionString店铺表备注备注
    configStringjson 字符串拓展属性配置
    lifeCycleInteger365表生命周期
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询汇总表使用的 FML 语句如下。

    show dws tables; 输出参数

    参数名参数类型示例值描述信息
    dataDomainUuidStringdm-12345数据域 UUID
    dataDomainCodeStringmember数据域 Code
    dataDomainNameString会员数据域名字
    timePeriodsList[{"uuid": "uuid", "code": "code", "name": "中文名称"}]时间周期列表
    uuidStringobj-123456对象唯一标识
    codeStringdws_001表名
    nameString支付汇总表表中文名称
    adjunctsList[{"uuid": "uuid", "code": "code", "name": "中文名称"}]修饰词列表
    dimensionsList[{"uuid": "uuid", "code": "code", "name": "中文名称"}]粒度
    bizEntityUuidStringdim-123456业务对象 UUID
    bizEntityCodeStringdim_shop业务对象英文缩写
    bizEntityNameString店铺表业务对象中文名称
    relUuidStringdim_a-123456关联维度 UUID
    typeInteger3表类型。取值为：3（汇总表）
    detailTypeStringdws_normal表具体类型。可取值如下：
    dws_normal：普通汇总表
    dws_advanced：轻度汇总表
    businessProcessUuidStringbp-123456业务过程 UUID
    businessUnitUuidStringbu-123456业务板块 UUID
    dataWarehouseLayerUuidStringly-123456数仓层 UUID
    businessCategoryUuidStringbc-123456业务分类 UUID
    ownerIdString0123456负责人 BaseId
    ownerNameString甲乙丙丁负责人名称
    descriptionString店铺表备注备注
    configStringjson 字符串拓展属性配置
    lifeCycleInteger365表生命周期
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询应用表使用的 FML 语句如下。

    show ads tables; 输出参数

    参数名参数类型示例值描述信息
    dataDomainUuidStringdm-12345数据域 UUID
    dataDomainCodeStringmember数据域 Code
    dataDomainNameString会员数据域名称
    timePeriodsList[{"uuid": "uuid", "code": "code", "name": "中文名称"}]时间周期列表
    uuidStringobj-123456对象唯一标识
    codeStringdws_001表名
    nameString支付汇总表表中文名称
    adjunctsList[{"uuid": "uuid", "code": "code", "name": "中文名称"}]修饰词列表
    dimensionsList[{"uuid": "uuid", "code": "code", "name": "中文名称"}]粒度
    bizEntityUuidStringdim-123456业务对象 UUID
    bizEntityCodeStringdim_shop业务对象英文缩写
    bizEntityNameString店铺表业务对象中文名称
    relUuidStringdim_a-123456关联维度 UUID
    typeInteger1表类型。可取值如下：
    0：事实表
    1：维度表
    detailTypeStringnormal表具体类型。可取值如下：
    普通维度
    枚举维度
    事务事实
    businessProcessUuidStringbp-123456业务过程 UUID
    businessUnitUuidStringbu-123456业务板块 UUID
    dataWarehouseLayerUuidStringly-123456数仓层 UUID
    businessCategoryUuidStringbc-123456业务分类 UUID
    ownerIdString0123456负责人 BaseId
    ownerNameString甲乙丙丁负责人名称
    descriptionString店铺表备注备注
    configStringjson 字符串拓展属性配置
    lifeCycleInteger365表生命周期
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询表信息同时返回字段信息使用的 FML 语句如下。

    show full tables; 输出参数

    参数名参数类型示例值描述信息
    tableUuidStringtb-123456表 UUID
    tableCodeStringdim_shop表编码
    tableNameString店铺表表名称
    columnCodeStringshop_id列编码
    columnNameString店铺 Id列名称
    columnUuidStringcol-123456列 UUID
    columnTypeStringSTRING列数据类型
    columnCategoryStringATTRIBUTE列类别

    查询列信息使用的 FML 语句如下。

    show columns from table_code; 输出参数

    参数名参数类型示例值描述信息
    codeStringseller_id列编码
    nameString卖家 Id列中文名
    dataTypeStringSTRING数据类型
    typeStringATTRIBUTE字段类型
    isPrimaryKeyBooleanfalse是否主键
    isPartitionKeyBooleanfalse是否分区键
    partitionOrderInteger1分区键顺序
    notNullBooleantrue是否非空
    dataDictionaryUuidStringmember_id数据字典编码
    dataDictionaryCodeString会员 Id数据字典名称
    codeTableUuidStringcd-123456关联码表 UUID
    codeTableCodeStringsex关联码表编码
    codeTableNameString性别关联码表名称
    measureUnitCodeStringpercent关联单位编码
    measureUnitNameString分关联单位名称
    sourceProjectNameStringautotest来源项目名称
    sourceTableCodeStringdict来源表编码
    sourceColumnCodeStringage来源字段编码
    sourceRelationTagStringlabel冗余关系标签
    descriptionString字段备注备注
    orderIdString1字段顺序
    columnGroupNameIntegercol_group_1所属字段组
    configStringjson 字符串拓展属性配置
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询修饰词使用的 FML 语句如下。

    show adjuncts; 输出参数

    参数名参数类型示例值描述信息
    businessUnitUuidStringbu-123456业务板块 UUID
    businessUnitCodeStringtest_bu业务板块 CODE
    businessUnitNameString测试板块业务板块 NAME
    dataDomainUuidStringdt-123456数据域 UUID
    dataDomainCodeStringmember数据域 CODE
    dataDomainNameString会员域数据域 NAME
    categoryUuidStringcy-123456业务分类 UUID
    categoryCodeStringtrade业务分类 CODE
    categoryNameString电商业务分类 NAME
    typeAdjunctTypeEnumDIM_VAL修饰词类型
    codeStringbeauty英文缩写
    nameString美妆中文名称
    extendNameStringbeauty英文名称
    descriptionString美妆描述描述
    bizExpressionString用于报表统计口径业务口径
    expressionStringbeauty = 1修饰词语义表达式
    bizEntityUuidStringdim-123456业务对象 UUID
    bizEntityCodeStringdim_shop业务对象英文缩写
    bizEntityNameString店铺表业务对象中文名称
    relUuidStringdim_a-123456关联维度 UUID
    ownerIdString0123456负责人 BaseId
    ownerNameString甲乙丙丁负责人名称
    isDeletedDeleteTagEnumNO是否被删除
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询时间周期使用的 FML 语句如下。

    show time_periods; 输出参数

    参数名参数类型示例值描述信息
    businessUnitUuidStringbu-123456所属的业务板块
    businessUnitCodeStringtest_bu业务板块 CODE
    typeTimePeriodTypeEnumDAY时间周期类型
    typeNameString天时间周期类型名称
    codeString1d英文缩写
    nameString1 天中文名称
    extendNameString1d英文名称
    descriptionString时间周期描述描述
    isDeletedDeleteTagEnumNO是否被删除
    timeBeginStringstart_expression开始时间表达式
    timeEndStringend_expression结束时间表达式
    gmtCreateTimeStamp1633885261000创建时间
    gmtModifiedTimeStamp1633885261000修改时间
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称
    ownerIdString0123456负责人 BaseId
    ownerNameString甲乙丙丁负责人名称
    beginOffsetInteger1开始周期偏移量
    endOffsetInteger1结束周期偏移量
    firstDayInteger1周期第一天（必填场景：type in[WEEK, MONTH, QUARTER, YEAR]）,"+ "取值范围:"+ "WEEK（初始星期，周日：1, 周一：2, 周二：3, 周三：4, 周四：5, 周五：6, 周六：7）, "+ "MONTH（初始号，月初：1, 月末：99, 2 号到 27 号：[2~27]）, "+ "QUARTER（初始月，1 月到 12 月：[0~11]）, "+ "YEAR（初始月，1 月到 12 月：[0~11]）
    uuidStringobj-123456对象唯一标识
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称

    查询原子指标使用的 FML 语句如下。

    show atomic indicators; 输出参数

    参数名参数类型示例值描述信息
    dataDistinctYesOrNoEnumYES数据是否需要去重。可取值如下：
    YES
    NO
    aggFunctionTypeAggFunctionEnumSUM指标聚合函数类型。可取值如下：
    SUM
    COUNT
    AVG
    MAX
    MIN
    RATE
    RANK
    UNDEFINED
    calExpressionStringprice计算口径(code)
    dataTypeDataTypeNameEnumTINYINT数据类型。可取值为：TINYINT、SMALLINT、INT、BIGINT、BINARY、FLOAT、DOUBLE、DECIMAL、VARCHAR、CHAR、STRING、DATE、DATETIME、TIMESTAMP、BOOLEAN、ARRAY、MAP、STRUCT、JSON
    dataRoundStringN数据精度。可取值如下：
    N
    M
    dataUnitUuidStringdu-123456指标单位 UUID
    dataUnitCodeStringpercent指标单位 CODE
    dataUnitNameString分指标单位名称
    bizExpressionString支付金额汇总业务口径
    dataRollUpTypeStringAGG_FUNCTION数据上卷方式。可取值如下：
    AGG_FUNCTION
    SUM_THEN_RATE
    RATE_THEN_AVG
    NOT_SUPPORT
    businessUnitUuidStringbu-0001业务板块 UUID
    businessUnitCodeStringproject_code业务板块 Code
    businessProcessUuidStringdi-0002业务过程 UUID
    businessProcessCodeStringpay业务过程 Code
    businessProcessNameString支付业务过程 Name
    dataDomainUuidStringdi-0003数据域 UUID
    dataDomainCodeStringtrd数据域 Code
    dataDomainNameString交易数据域 Name
    categoryUuidStringdi-0001业务分类 UUID
    categoryCodeStringtb业务分类 Code
    categoryNameString淘宝业务分类 Name
    typeStringATOMIC指标类型。可取值如下：
    ATOMIC
    DERIVATIVE
    DERIVATIVE_COMPOSITE
    codeStringpay_amt英文缩写
    nameString支付金额中文名称
    extendNameStringpay amount英文名称
    descriptionStringremark描述
    statusStringNORMAL指标状态。可取值如下：
    DRAFT
    DEV
    NORMAL
    ownerIdString0001负责人 BaseId
    ownerNameString负责人姓名负责人名称
    isDeletedDeleteTagEnumNO是否被删除。可取值如下：
    YES
    NO
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询派生指标使用的 FML 语句如下。

    show derivative indicators; 输出参数

    参数名参数类型示例值描述信息
    timePeriodUuidStringtp-0001时间周期 UUID
    timePeriodCodeString1d时间周期英文缩写
    timePeriodNameString近 1 天时间周期中文名称
    adjunctUuidsList["adj-001"]修饰词 UUID 列表
    adjunctCodesList["male"]修饰词英缩写列表
    adjunctNamesList男性修饰词中文名称列表
    atomicIndicatorUuidStringind-a-0001原子指标 UUID
    atomicIndicatorCodeStringpay_amt原子指标英文缩写
    atomicIndicatorNameString支付金额原子指标中文名称
    dataTypeDataTypeNameEnumBIGINT数据类型。可取值为：TINYINT、SMALLINT、INT、BIGINT、BINARY、FLOAT、DOUBLE、DECIMAL、VARCHAR、CHAR、STRING、DATE、DATETIME、TIMESTAMP、BOOLEAN、ARRAY、MAP、STRUCT、JSON
    bizEntityUuidStringdim-123456业务对象 UUID
    bizEntityCodeStringdim_shop业务对象英文缩写
    bizEntityNameString店铺表业务对象中文名称
    relUuidStringdim_a-123456关联维度 UUID
    indHashStringhash-0001指标 hash
    suggestCodeStringpay_amt_1d推荐编码
    businessUnitUuidStringbu-0001业务板块 UUID
    businessUnitCodeStringproject_code业务板块 Code
    businessProcessUuidStringdi-0002业务过程 UUID
    businessProcessCodeStringpay业务过程 Code
    businessProcessNameString支付业务过程 Name
    dataDomainUuidStringdi-0003数据域 UUID
    dataDomainCodeStringtrd数据域 Code
    dataDomainNameString交易数据域 Name
    categoryUuidStringdi-0001业务分类 UUID
    categoryCodeStringtb业务分类 Code
    categoryNameString淘宝业务分类 Name
    typeIndicatorTypeEnumATOMIC指标类型。可取值如下：
    ATOMIC
    DERIVATIVE
    DERIVATIVE_COMPOSITE
    codeStringpay_amt英文缩写
    nameString支付金额中文名称
    extendNameStringpay amount英文名称
    descriptionStringremark描述
    statusIndicatorStatusEnumNORMAL指标状态。可取值如下：
    DRAFT
    DEV
    NORMAL
    ownerIdString0001负责人 BaseId
    ownerNameString负责人姓名负责人名称
    isDeletedDeleteTagEnumNO是否被删除。可取值如下：
    YES
    NO
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000创建时间
    gmtModifiedTimeStamp1644459965000修改时间
    creatorIdString0123456创建人 BaseId
    creatorNameString甲乙丙丁创建人名称
    modifierIdString0123456修改人 BaseId
    modifierNameString甲乙丙丁修改人名称

    查询复合指标使用的 FML 语句如下。

    show derivative composite indicators; 输出参数

    参数名参数类型示例值描述信息
    businessUnitCodeStringproject_code工作空间名称
    businessProcessUuidStringdi-0002业务过程 UUID
    businessProcessCodeStringpay业务过程 Code
    businessProcessNameString支付业务过程名称
    dataDomainUuidStringdi-0003数据域 UUID
    dataDomainCodeStringtrd数据域 Code
    dataDomainNameString交易数据域名称
    categoryUuidStringdi-0001业务分类 UUID
    categoryCodeStringtb业务分类 Code
    categoryNameString淘宝业务分类名称
    typeStringDERIVATIVE_COMPOSITE计算模式。可取值 DERIVATIVE_COMPOSITE （计算表达式）、DERIVATIVE_COMPARISON（同环比）
    codeStringpay_amt指标英文缩写
    nameString支付金额指标中文名称
    extendNameStringpay amount指标英文名称
    descriptionStringremark指标描述信息
    calculateExpressionString{@pay_amt_1d[近 1 天_支付金额]}/{@pay_amt_1m[近 30 天_支付金额]}计算表达式
    comparisonPeriodTypeStringDAY_MOM同环比对比类型。取值如下： DAY_MOM（日环比）、 WEEK_MOM（周环比）、WEEK_YOY（周同比）、MONTH_MOM（月环比）、MONTH_YOY（月同比）、QUARTER_MOM（季度环比）、YEAR_MOM（年环比）、YEAR_YOY（年同比）
    comparisonIndicatorUuidStringobj-123456同环比对比指标的 UUID
    comparisonIndicatorCodeStringpay_amt_1d同环比对比指标的英文缩写
    comparisonIndicatorNameString近 1 天_支付金额同环比对比指标的中文名称
    ownerIdString0001指标负责人的 BaseId
    ownerNameString张三指标负责人的姓名
    isDeletedDeleteTagEnumNO是否被删除，可取值 YES 或 NO。
    uuidStringobj-123456对象唯一标识
    gmtCreateTimeStamp1644397025000指标创建时间
    gmtModifiedTimeStamp1644459965000指标修改时间
    creatorIdString0123456指标创建人 BaseId
    creatorNameString甲乙丙丁指标创建人名称
    modifierIdString0123456指标修改人 BaseId
    modifierNameString甲乙丙丁指标修改人名称

    查询单个指标所依赖模型的相关信息，使用的 FML 语句如下。

    show statistic indicator table_code; 输出参数

    参数名参数类型示例值描述信息
    uuidStringobj-123456指标唯一标识
    codeStringpay_amt指标英文缩写
    nameString支付金额指标中文名称
    extendNameStringpay amount指标英文名称
    relationsList示例请参见下文依赖指标的模型信息列表，EntityInfo 的结构参见下文

    EntityInfo 的结构示例及参数描述如下。

    [
    {
        "uuid": "uuid",
        "code": "code",
        "name": "中文名称",
        "extendName": "full name in English",
        "entityType": "EntityTypeEnum.BASE_DERIVATIVE_INDICATOR",
        "entityTypeName": "实体类型名称",
        "entitySubType": "DERIVATIVE_INDICATOR",
        "entitySubTypeName": "实体子类型名称",
        "ownerId": "0001",
        "ownerName": "负责人姓名"
    }
]
    参数名参数类型示例值描述信息
    uuidStringobj-123456模型唯一标识
    codeStringdws_001模型英文缩写
    nameString支付汇总表模型中文名称
    extendNameStringdws_001模型英文名称
    entityTypeEntityTypeEnumTable依赖指标的实体类型。取值包括但不限于TABLE、BASE_ATOMIC_INDICATOR、BASE_DERIVATIVE_INDICATOR
    entityTypeNameString表实体类型名称
    entitySubTypeStringDWS_TABLE实体子类型。取值包括但不限于DWS_TABLE、ATOMIC_INDICATOR、DERIVATIVE_INDICATOR
    entitySubTypeNameString汇总表实体子类型名称
    ownerIdString0001负责人 BaseId
    ownerNameString张三负责人名称

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4",
  "ReturnValue": [
    {
      "test": "test",
      "test2": 1
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    400Valid.FML.NoPermissionYou are not authorized to access the project resources.您没有权限访问当前项目资源。
    400Valid.FML.OnlySupportQueryStatementOnly FML query statement is supported.只支持FML查询语句。
    400Valid.FML.ProjectNotExistThe project does not exist.项目信息不存在，请检查输入参数。
    400Valid.FML.StatementNotValidThe FML statement is invalid.FML语句不合法，请参考FML语法文档：https://dataworks-doc.yuque.com/docs/share/ff7899ed-c433-4970-b20e-6582ea3939f3?#
    400Valid.FML.ProductExpired智能数据建模产品购买已到期智能数据建模产品购买已到期
    400Valid.FML.ProductNotActivated智能数据建模产品未开通智能数据建模产品未开通
    500Execute.FML.ProcessErrorFailed to execute FML statement.FML执行失败，请稍后再试！

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2021-11-16OpenAPI 错误码发生变更查看变更详情