QueryPublicModelEngine - 查询数据建模引擎的信息_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Text	string	是	输入查询引擎信息的 FML 语句，详情请参见使用 FML 语句配置并管理数据表。当前仅支持 show 语句。	show dim tables
ProjectId	string	是	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间管理页面获取 ID。	1234

返回参数

名称	类型	描述	示例值
	object	是调用 FML 语句查询返回的结果。
RequestId	string	本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。	4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4
ReturnValue	object []	是通过 FML 语句查询返回的列表信息。
	object	返回通过 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;
输出参数

参数名	参数类型	示例值	描述信息
code	String	dws	数仓分层编码
englishName	String	dws	数仓分层英文名
name	String	汇总层	数仓分层中文名
ownerId	String	0123456	负责人 ID
ownerName	String	甲乙丙丁	负责人名称
description	String	汇总层描述	备注
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show domains;
输出参数

参数名	参数类型	示例值	描述信息
code	String	member	数据域编码
englishName	String	member	数据域英文名
name	String	会员	数据域中文名
ownerId	String	0123456	负责人 ID
ownerName	String	甲乙丙丁	负责人名称
businessUnitCode	String	bu-123456	业务板块编码
description	String	会员域备注	备注
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseIdID
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseIdID
modifierName	String	甲乙丙丁	修改人名称

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

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

输出参数

参数名	参数类型	示例值	描述信息
code	String	bp-123456	业务过程编码
englishName	String	pay	业务过程英文名
name	String	付款	业务过程中文名
dataDomainCode	String	trade	所属数据域编码
dataDomainName	String	交易	所属数据域中文名
dataDomainUuid	String	dm-123456	所属数据域 UUID
ownerId	String	0123456	负责人 BaseId
ownerName	String	甲乙丙丁	负责人名称
description	String	付款	备注
source	Integer	2	创建来源。可取值如下： 1：系统创建 2：用户创建
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	creatorId	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

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

输出参数

参数名	参数类型	示例值	描述信息
categoryDetail	DirectoryDetailDTO	{"uuid": "cate_uuid", "code": "trd", "name": "交易"}	业务分类详细信息
name	String	电商	目录名称
detailType	String	DICT	目录子类型
parentUuid	String	dy-123456	父级目录 UUID
description	String	描述信息	目录描述
code	String	ind	业务分类 code
dataDomains	List	[{"uuid": "domain1", "code": "trd", "name": "交易域"}]	业务分类下挂靠数据域
ownerId	String	0123456	负责人 BaseId
ownerName	String	甲乙丙丁	负责人名称
businessUnitCode	String	bu-123456	业务板块编码
description	String	描述信息	目录描述
categoryPath	String	tm.ind	业务分类 path

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

show markets; 输出参数

参数名	参数类型	示例值	描述信息
categoryDetail	DirectoryDetailDTO	{"uuid": "cate_uuid", "code": "trd", "name": "交易"}	数据集市详细信息
name	String	电商	目录名称
detailType	String	DICT	目录子类型
parentUuid	String	dy-123456	父级目录 UUID
description	String	描述信息	目录描述
code	String	ind	业务分类 code
subDetailType	String	common	目录子类型细分类型
auditDTOList	List	[{"baseId":"123","showName":"test"}]	审核人员列表
code	String	member	数据域编码
englishName	String	member	数据域英文名
name	String	会员	数据域中文名
ownerId	String	0123456	负责人 BaseId
ownerName	String	甲乙丙丁	负责人名称
businessUnitCode	String	bu-123456	业务板块编码
description	String	会员域备注	备注
auditDTOList	List	[{"baseId":"123","showName":"test"}]	审核人员列表
categoryPath	String	tm.ind	业务分类 path

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

show subjects; 输出参数

参数名	参数类型	示例值	描述信息
categoryDetail	DirectoryDetailDTO	{"uuid": "cate_uuid", "code": "trd", "name": "交易"}	主题详细信息
name	String	电商	目录名称
detailType	String	DICT	目录子类型
parentUuid	String	dy-123456	父级目录 UUID
description	String	描述信息	目录描述
code	String	ind	业务分类 code
subDetailType	String	common	目录子类型细分类型
auditDTOList	List	[{"baseId":"123","showName":"test"}]	审核人员列表
code	String	member	数据域编码
englishName	String	member	数据域英文名
name	String	会员	数据域中文名
ownerId	String	0123456	负责人 BaseId
ownerName	String	甲乙丙丁	负责人名称
businessUnitCode	String	bu-123456	业务板块编码
description	String	会员域备注	备注
auditDTOList	List	[{"baseId":"123","showName":"test"}]	审核人员列表
categoryPath	String	tm.ind	业务分类 path

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

show dict groups; 输出参数

参数名	参数类型	示例值	描述信息
name	String	电商	目录名称
detailType	String	DICT	目录子类型
parentUuid	String	dy-123456	父级目录 UUID
description	String	描述信息	目录描述
code	String	ind	业务分类 code
uuid	List	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show dicts; 输出参数

参数名	参数类型	示例值	描述信息
code	String	shop_type	英文缩写
englishName	String	shop type	英文名称
name	String	店铺类型	中文名称
no	String	SN00001	标准编号
dataType	String	STRING	数据类型
length	Integer	10	列长度
numericalPrecision	Integer	2	列精度
notNull	Boolean	false	是否不为空
defaultValue	String	旗舰店	默认值
parentNo	String	SN0001	父级标准编号
parentName	String	店铺	父级标准名称
codeTableNo	String	shop_type	引用码表编号
codeTableName	String	店铺类型码表	引用码表名称
codeTableUuid	String	tb-0001	引用码表 UUID
directoryUuid	String	所属目录 UUID	所属目录 UUID
directoryName	String	店铺目录	所属目录名称
description	String	remark	备注
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show code tables; 输出参数

参数名	参数类型	示例值	描述信息
code	String	shop_type	代码编码
name	String	店铺类型	代码名称
extendName	String	shop type	英文名称
description	String	remark	描述
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show measure_unit groups; 输出参数

参数名	参数类型	示例值	描述信息
name	String	电商	目录名称
detailType	String	DICT	目录子类型
parentUuid	String	dy-123456	父级目录 UUID
description	String	描述信息	目录描述
code	String	ind	分类 code
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show measure_units; 输出参数

参数名	参数类型	示例值	描述信息
code	String	yuan	英文缩写
englishName	String	RMB	英文名称
name	String	元	列中文名称
directoryUuid	String	di-0001	单位分组 UUID
directoryName	String	货币	单位分组名称
description	String	remark	备注
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show codes from code_table; 输出参数

参数名	参数类型	示例值	描述信息
codeContent	String	0	code 内容值
extendNameContent	String	female	扩展标准代码名称
nameContent	String	女性	标准代码名称
description	String	remark	标准代码描述
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show naming dicts; 输出参数

参数名	参数类型	示例值	描述信息
code	String	shop	英文缩写
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
extendName	String	shop	英文名称
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称
name	String	店铺	中文名称
ownerId	String	0123456	负责人 BaseId
ownerName	String	甲乙丙丁	负责人名称
uuid	String	obj-123456	对象唯一标识

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

show tables; 输出参数

参数名	参数类型	示例值	描述信息
code	String	dim_shop	表编码
name	String	店铺维度表	表中文名
type	Integer	1	表类型。取值如下： 0：事实表 1：维度表 3：汇总表 4：应用表 5：贴源表 6：维度
detailType	String	normal	表具体类型。可取值如下：普通维度枚举维度事务事实
businessProcessUuid	String	bp-123456	业务过程 UUID
businessUnitUuid	String	bu-123456	业务板块 UUID
dataWarehouseLayerUuid	String	ly-123456	数仓层 UUID
businessCategoryUuid	String	bc-123456	业务分类 UUID
ownerId	String	0123456	负责人 BaseId
ownerName	String	甲乙丙丁	负责人名称
description	String	店铺表备注	备注
config	String	json 字符串	拓展属性配置
lifeCycle	Integer	365	表生命周期
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show dim tables;
输出参数

参数名	参数类型	示例值	描述信息
code	String	dim_shop	表编码
name	String	店铺维度表	表中文名
type	Integer	1	表类型。可取值如下： 0：事实表 1：维度表
detailType	String	normal	表具体类型。可取值如下：普通维度枚举维度事务事实
businessProcessUuid	String	bp-123456	业务过程 UUID
businessUnitUuid	String	bu-123456	业务板块 UUID
dataWarehouseLayerUuid	String	ly-123456	数仓层 UUID
businessCategoryUuid	String	bc-123456	业务分类 UUID
ownerId	String	0123456	负责人 BaseId
ownerName	String	甲乙丙丁	负责人名称
description	String	店铺表备注	备注
config	String	json 字符串	拓展属性配置
lifeCycle	Integer	365	表生命周期
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show fact tables; 输出参数

参数名	参数类型	示例值	描述信息
code	String	dim_shop	表编码
name	String	店铺维度表	表中文名
type	Integer	1	表类型。可取值如下： 0：事实表 1：维度表
detailType	String	normal	表具体类型。可取值如下：普通维度枚举维度事务事实
businessProcessUuid	String	bp-123456	业务过程 UUID
businessUnitUuid	String	bu-123456	业务板块 UUID
dataWarehouseLayerUuid	String	ly-123456	数仓层 UUID
businessCategoryUuid	String	bc-123456	业务分类 UUID
ownerId	String	0123456	负责人 BaseId
ownerName	String	甲乙丙丁	负责人名称
description	String	店铺表备注	备注
config	String	json 字符串	拓展属性配置
lifeCycle	Integer	365	表生命周期
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show dws tables; 输出参数

参数名	参数类型	示例值	描述信息
dataDomainUuid	String	dm-12345	数据域 UUID
dataDomainCode	String	member	数据域 Code
dataDomainName	String	会员	数据域名字
timePeriods	List	[{"uuid": "uuid", "code": "code", "name": "中文名称"}]	时间周期列表
uuid	String	obj-123456	对象唯一标识
code	String	dws_001	表名
name	String	支付汇总表	表中文名称
adjuncts	List	[{"uuid": "uuid", "code": "code", "name": "中文名称"}]	修饰词列表
dimensions	List	[{"uuid": "uuid", "code": "code", "name": "中文名称"}]	粒度
bizEntityUuid	String	dim-123456	业务对象 UUID
bizEntityCode	String	dim_shop	业务对象英文缩写
bizEntityName	String	店铺表	业务对象中文名称
relUuid	String	dim_a-123456	关联维度 UUID
type	Integer	3	表类型。取值为：3（汇总表）
detailType	String	dws_normal	表具体类型。可取值如下： dws_normal：普通汇总表 dws_advanced：轻度汇总表
businessProcessUuid	String	bp-123456	业务过程 UUID
businessUnitUuid	String	bu-123456	业务板块 UUID
dataWarehouseLayerUuid	String	ly-123456	数仓层 UUID
businessCategoryUuid	String	bc-123456	业务分类 UUID
ownerId	String	0123456	负责人 BaseId
ownerName	String	甲乙丙丁	负责人名称
description	String	店铺表备注	备注
config	String	json 字符串	拓展属性配置
lifeCycle	Integer	365	表生命周期
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show ads tables; 输出参数

参数名	参数类型	示例值	描述信息
dataDomainUuid	String	dm-12345	数据域 UUID
dataDomainCode	String	member	数据域 Code
dataDomainName	String	会员	数据域名称
timePeriods	List	[{"uuid": "uuid", "code": "code", "name": "中文名称"}]	时间周期列表
uuid	String	obj-123456	对象唯一标识
code	String	dws_001	表名
name	String	支付汇总表	表中文名称
adjuncts	List	[{"uuid": "uuid", "code": "code", "name": "中文名称"}]	修饰词列表
dimensions	List	[{"uuid": "uuid", "code": "code", "name": "中文名称"}]	粒度
bizEntityUuid	String	dim-123456	业务对象 UUID
bizEntityCode	String	dim_shop	业务对象英文缩写
bizEntityName	String	店铺表	业务对象中文名称
relUuid	String	dim_a-123456	关联维度 UUID
type	Integer	1	表类型。可取值如下： 0：事实表 1：维度表
detailType	String	normal	表具体类型。可取值如下：普通维度枚举维度事务事实
businessProcessUuid	String	bp-123456	业务过程 UUID
businessUnitUuid	String	bu-123456	业务板块 UUID
dataWarehouseLayerUuid	String	ly-123456	数仓层 UUID
businessCategoryUuid	String	bc-123456	业务分类 UUID
ownerId	String	0123456	负责人 BaseId
ownerName	String	甲乙丙丁	负责人名称
description	String	店铺表备注	备注
config	String	json 字符串	拓展属性配置
lifeCycle	Integer	365	表生命周期
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show full tables; 输出参数

参数名	参数类型	示例值	描述信息
tableUuid	String	tb-123456	表 UUID
tableCode	String	dim_shop	表编码
tableName	String	店铺表	表名称
columnCode	String	shop_id	列编码
columnName	String	店铺 Id	列名称
columnUuid	String	col-123456	列 UUID
columnType	String	STRING	列数据类型
columnCategory	String	ATTRIBUTE	列类别

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

show columns from table_code; 输出参数

参数名	参数类型	示例值	描述信息
code	String	seller_id	列编码
name	String	卖家 Id	列中文名
dataType	String	STRING	数据类型
type	String	ATTRIBUTE	字段类型
isPrimaryKey	Boolean	false	是否主键
isPartitionKey	Boolean	false	是否分区键
partitionOrder	Integer	1	分区键顺序
notNull	Boolean	true	是否非空
dataDictionaryUuid	String	member_id	数据字典编码
dataDictionaryCode	String	会员 Id	数据字典名称
codeTableUuid	String	cd-123456	关联码表 UUID
codeTableCode	String	sex	关联码表编码
codeTableName	String	性别	关联码表名称
measureUnitCode	String	percent	关联单位编码
measureUnitName	String	分	关联单位名称
sourceProjectName	String	autotest	来源项目名称
sourceTableCode	String	dict	来源表编码
sourceColumnCode	String	age	来源字段编码
sourceRelationTag	String	label	冗余关系标签
description	String	字段备注	备注
orderId	String	1	字段顺序
columnGroupName	Integer	col_group_1	所属字段组
config	String	json 字符串	拓展属性配置
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show adjuncts; 输出参数

参数名	参数类型	示例值	描述信息
businessUnitUuid	String	bu-123456	业务板块 UUID
businessUnitCode	String	test_bu	业务板块 CODE
businessUnitName	String	测试板块	业务板块 NAME
dataDomainUuid	String	dt-123456	数据域 UUID
dataDomainCode	String	member	数据域 CODE
dataDomainName	String	会员域	数据域 NAME
categoryUuid	String	cy-123456	业务分类 UUID
categoryCode	String	trade	业务分类 CODE
categoryName	String	电商	业务分类 NAME
type	AdjunctTypeEnum	DIM_VAL	修饰词类型
code	String	beauty	英文缩写
name	String	美妆	中文名称
extendName	String	beauty	英文名称
description	String	美妆描述	描述
bizExpression	String	用于报表统计口径	业务口径
expression	String	beauty = 1	修饰词语义表达式
bizEntityUuid	String	dim-123456	业务对象 UUID
bizEntityCode	String	dim_shop	业务对象英文缩写
bizEntityName	String	店铺表	业务对象中文名称
relUuid	String	dim_a-123456	关联维度 UUID
ownerId	String	0123456	负责人 BaseId
ownerName	String	甲乙丙丁	负责人名称
isDeleted	DeleteTagEnum	NO	是否被删除
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show time_periods; 输出参数

参数名	参数类型	示例值	描述信息
businessUnitUuid	String	bu-123456	所属的业务板块
businessUnitCode	String	test_bu	业务板块 CODE
type	TimePeriodTypeEnum	DAY	时间周期类型
typeName	String	天	时间周期类型名称
code	String	1d	英文缩写
name	String	1 天	中文名称
extendName	String	1d	英文名称
description	String	时间周期描述	描述
isDeleted	DeleteTagEnum	NO	是否被删除
timeBegin	String	start_expression	开始时间表达式
timeEnd	String	end_expression	结束时间表达式
gmtCreate	TimeStamp	1633885261000	创建时间
gmtModified	TimeStamp	1633885261000	修改时间
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称
ownerId	String	0123456	负责人 BaseId
ownerName	String	甲乙丙丁	负责人名称
beginOffset	Integer	1	开始周期偏移量
endOffset	Integer	1	结束周期偏移量
firstDay	Integer	1	周期第一天（必填场景：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]）
uuid	String	obj-123456	对象唯一标识
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称

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

show atomic indicators; 输出参数

参数名	参数类型	示例值	描述信息
dataDistinct	YesOrNoEnum	YES	数据是否需要去重。可取值如下： YES NO
aggFunctionType	AggFunctionEnum	SUM	指标聚合函数类型。可取值如下： SUM COUNT AVG MAX MIN RATE RANK UNDEFINED
calExpression	String	price	计算口径(code)
dataType	DataTypeNameEnum	TINYINT	数据类型。可取值为：TINYINT、SMALLINT、INT、BIGINT、BINARY、FLOAT、DOUBLE、DECIMAL、VARCHAR、CHAR、STRING、DATE、DATETIME、TIMESTAMP、BOOLEAN、ARRAY、MAP、STRUCT、JSON
dataRound	String	N	数据精度。可取值如下： N M
dataUnitUuid	String	du-123456	指标单位 UUID
dataUnitCode	String	percent	指标单位 CODE
dataUnitName	String	分	指标单位名称
bizExpression	String	支付金额汇总	业务口径
dataRollUpType	String	AGG_FUNCTION	数据上卷方式。可取值如下： AGG_FUNCTION SUM_THEN_RATE RATE_THEN_AVG NOT_SUPPORT
businessUnitUuid	String	bu-0001	业务板块 UUID
businessUnitCode	String	project_code	业务板块 Code
businessProcessUuid	String	di-0002	业务过程 UUID
businessProcessCode	String	pay	业务过程 Code
businessProcessName	String	支付	业务过程 Name
dataDomainUuid	String	di-0003	数据域 UUID
dataDomainCode	String	trd	数据域 Code
dataDomainName	String	交易	数据域 Name
categoryUuid	String	di-0001	业务分类 UUID
categoryCode	String	tb	业务分类 Code
categoryName	String	淘宝	业务分类 Name
type	String	ATOMIC	指标类型。可取值如下： ATOMIC DERIVATIVE DERIVATIVE_COMPOSITE
code	String	pay_amt	英文缩写
name	String	支付金额	中文名称
extendName	String	pay amount	英文名称
description	String	remark	描述
status	String	NORMAL	指标状态。可取值如下： DRAFT DEV NORMAL
ownerId	String	0001	负责人 BaseId
ownerName	String	负责人姓名	负责人名称
isDeleted	DeleteTagEnum	NO	是否被删除。可取值如下： YES NO
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show derivative indicators; 输出参数

参数名	参数类型	示例值	描述信息
timePeriodUuid	String	tp-0001	时间周期 UUID
timePeriodCode	String	1d	时间周期英文缩写
timePeriodName	String	近 1 天	时间周期中文名称
adjunctUuids	List	["adj-001"]	修饰词 UUID 列表
adjunctCodes	List	["male"]	修饰词英缩写列表
adjunctNames	List	男性	修饰词中文名称列表
atomicIndicatorUuid	String	ind-a-0001	原子指标 UUID
atomicIndicatorCode	String	pay_amt	原子指标英文缩写
atomicIndicatorName	String	支付金额	原子指标中文名称
dataType	DataTypeNameEnum	BIGINT	数据类型。可取值为：TINYINT、SMALLINT、INT、BIGINT、BINARY、FLOAT、DOUBLE、DECIMAL、VARCHAR、CHAR、STRING、DATE、DATETIME、TIMESTAMP、BOOLEAN、ARRAY、MAP、STRUCT、JSON
bizEntityUuid	String	dim-123456	业务对象 UUID
bizEntityCode	String	dim_shop	业务对象英文缩写
bizEntityName	String	店铺表	业务对象中文名称
relUuid	String	dim_a-123456	关联维度 UUID
indHash	String	hash-0001	指标 hash
suggestCode	String	pay_amt_1d	推荐编码
businessUnitUuid	String	bu-0001	业务板块 UUID
businessUnitCode	String	project_code	业务板块 Code
businessProcessUuid	String	di-0002	业务过程 UUID
businessProcessCode	String	pay	业务过程 Code
businessProcessName	String	支付	业务过程 Name
dataDomainUuid	String	di-0003	数据域 UUID
dataDomainCode	String	trd	数据域 Code
dataDomainName	String	交易	数据域 Name
categoryUuid	String	di-0001	业务分类 UUID
categoryCode	String	tb	业务分类 Code
categoryName	String	淘宝	业务分类 Name
type	IndicatorTypeEnum	ATOMIC	指标类型。可取值如下： ATOMIC DERIVATIVE DERIVATIVE_COMPOSITE
code	String	pay_amt	英文缩写
name	String	支付金额	中文名称
extendName	String	pay amount	英文名称
description	String	remark	描述
status	IndicatorStatusEnum	NORMAL	指标状态。可取值如下： DRAFT DEV NORMAL
ownerId	String	0001	负责人 BaseId
ownerName	String	负责人姓名	负责人名称
isDeleted	DeleteTagEnum	NO	是否被删除。可取值如下： YES NO
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	创建时间
gmtModified	TimeStamp	1644459965000	修改时间
creatorId	String	0123456	创建人 BaseId
creatorName	String	甲乙丙丁	创建人名称
modifierId	String	0123456	修改人 BaseId
modifierName	String	甲乙丙丁	修改人名称

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

show derivative composite indicators; 输出参数

参数名	参数类型	示例值	描述信息
businessUnitCode	String	project_code	工作空间名称
businessProcessUuid	String	di-0002	业务过程 UUID
businessProcessCode	String	pay	业务过程 Code
businessProcessName	String	支付	业务过程名称
dataDomainUuid	String	di-0003	数据域 UUID
dataDomainCode	String	trd	数据域 Code
dataDomainName	String	交易	数据域名称
categoryUuid	String	di-0001	业务分类 UUID
categoryCode	String	tb	业务分类 Code
categoryName	String	淘宝	业务分类名称
type	String	DERIVATIVE_COMPOSITE	计算模式。可取值 DERIVATIVE_COMPOSITE （计算表达式）、DERIVATIVE_COMPARISON（同环比）
code	String	pay_amt	指标英文缩写
name	String	支付金额	指标中文名称
extendName	String	pay amount	指标英文名称
description	String	remark	指标描述信息
calculateExpression	String	{@pay_amt_1d[近 1 天_支付金额]}/{@pay_amt_1m[近 30 天_支付金额]}	计算表达式
comparisonPeriodType	String	DAY_MOM	同环比对比类型。取值如下： DAY_MOM（日环比）、 WEEK_MOM（周环比）、WEEK_YOY（周同比）、MONTH_MOM（月环比）、MONTH_YOY（月同比）、QUARTER_MOM（季度环比）、YEAR_MOM（年环比）、YEAR_YOY（年同比）
comparisonIndicatorUuid	String	obj-123456	同环比对比指标的 UUID
comparisonIndicatorCode	String	pay_amt_1d	同环比对比指标的英文缩写
comparisonIndicatorName	String	近 1 天_支付金额	同环比对比指标的中文名称
ownerId	String	0001	指标负责人的 BaseId
ownerName	String	张三	指标负责人的姓名
isDeleted	DeleteTagEnum	NO	是否被删除，可取值 YES 或 NO。
uuid	String	obj-123456	对象唯一标识
gmtCreate	TimeStamp	1644397025000	指标创建时间
gmtModified	TimeStamp	1644459965000	指标修改时间
creatorId	String	0123456	指标创建人 BaseId
creatorName	String	甲乙丙丁	指标创建人名称
modifierId	String	0123456	指标修改人 BaseId
modifierName	String	甲乙丙丁	指标修改人名称

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

show statistic indicator table_code; 输出参数

参数名	参数类型	示例值	描述信息
uuid	String	obj-123456	指标唯一标识
code	String	pay_amt	指标英文缩写
name	String	支付金额	指标中文名称
extendName	String	pay amount	指标英文名称
relations	List	示例请参见下文	依赖指标的模型信息列表，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": "负责人姓名"
    }
]

参数名	参数类型	示例值	描述信息
uuid	String	obj-123456	模型唯一标识
code	String	dws_001	模型英文缩写
name	String	支付汇总表	模型中文名称
extendName	String	dws_001	模型英文名称
entityType	EntityTypeEnum	Table	依赖指标的实体类型。取值包括但不限于`TABLE、BASE_ATOMIC_INDICATOR、BASE_DERIVATIVE_INDICATOR`
entityTypeName	String	表	实体类型名称
entitySubType	String	DWS_TABLE	实体子类型。取值包括但不限于`DWS_TABLE、ATOMIC_INDICATOR、DERIVATIVE_INDICATOR`
entitySubTypeName	String	汇总表	实体子类型名称
ownerId	String	0001	负责人 BaseId
ownerName	String	张三	负责人名称

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间

变更内容概要

操作

2021-11-16

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：429
	删除错误码：500