新增数据集

接口说明

本接口是用于在指标平台中创建一个数据集。

接口URL

POST  Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/dataset/create

anymetrics_host:anymetrics_port 获取方式请参考：调用方式

公共请求参数

参数	类型	是否必选	最大长度	描述	示例值
tenant-id	String	是	32	当前租户 ID	tn_125288
auth-type	String	是	32	身份类型，UID/TOKEN	UID
auth-value	String	是	32	UID 或者TOKEN 值	341523017135816704

公共参数获取方式

tenant-id 与 auth-value：在 Aloudata CAN 顶部导航栏选择指标应用，左边菜单栏选择 API 集成。在 API 集成界面获取取到tenant-id 与auth-value。

请求参数

主表：请求参数总览

参数	类型	是否必选	描述	示例值
name	String	是	数据集名称	datasetName
displayName	String	是	数据集显示名	dataset123
description	String	否	数据集描述	交易记录数据集
categoryId	String	否	数据集类目 ID
sourceInfo	Object	是	来源信息，详情见【子表 1】	-
defColumns	Array	否	列定义数组，列定义数组（每个元素结构见【子表 2】）	-

子表 1：sourceInfo 参数详情

参数	类型	是否必选	描述	示例值
name	String	是	来源表名称	datet
displayName	String	是	来源表显示名	dataset123
description	String	是	来源表描述	交易记录数据集
content	String	是	来源数据内容（物理表填表的 guid，如:jmsr.`default_catalog.jingming`.datet；SQL 来源填 SQL 语句）	jmsr.`default_catalog.jingming`.datet
type	String	是	来源数据类型（取值为TABLE或SQL）	TABLE
datasourceItems	Array	是	数据源项数组（目前仅支持一个元素，需包含数据源 guid、名称及引擎类型）	[{"id":"jmsr", "name":"jmsR", "queryEngineType":"STARROCKS"}]

详情：若来源类型为TABLE，content 需填写物理表的 guid；若为SQL，则填写具体 SQL 语句。

子表 2：defColumns 参数详情

子参数	类型	是否必选	描述
name	String	是	字段名称（不可修改）
displayName	String	是	字段展示名称
description	String	否	列描述
type	String	是	列类型（枚举值：DIMENSION/MEASURE）
expr	String	是	字段公式（如['datet'/'date_type']）
sourceColumn	String	否	来源字段（物理表字段时必填）

响应参数

{
    "data": true,
    "success": true,
    "code": 200,
    "message": null,
    "traceId": ""
}

入参实例

{
    "name": "datetapi",
    "displayName": "datetapi",
    "description": "datetapi",
    "sourceInfo": {
        "name": "datet",
        "displayName": "datet",
        "description": "sad",
        "content": "jmsr.`default_catalog.jingming`.datet",
        "type": "TABLE",
        "datasourceItems": [
            {
                "id": "jmsr",
                "name": "jmsR",
                "queryEngineType": "STARROCKS"
            }
        ]
    }
}