全部產品
Search

搜尋本產品

    DataWorks：QueryPublicModelEngine - 查詢資料建模引擎的資訊

    文件中心

    DataWorks：QueryPublicModelEngine - 查詢資料建模引擎的資訊

    更新時間：Mar 21, 2026

    使用FML語句查詢資料建模引擎的資訊。

    介面說明

    • 每次調用該介面均需使用 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

    array<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;
    輸出參數

    參數名參數類型樣本值描述資訊
    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

    錯誤碼

    錯誤資訊

    描述
    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執行失敗，請稍後再試！

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。