修改数据集

接口说明

本接口用于在指标平台中修改一个数据集。

接口URL

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

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

请求参数

公共请求参数(HEADERS)

参数	类型	是否必选	描述
tenant-id	String	是	租户ID，用于指标查询内容所在的租户
auth-type	String	是	认证方式。支持 UID、TOKEN、ACCOUNT、APIKEY
auth-value	String	是	与 auth-type 对应的认证值

公共参数获取方式

tenant-id 可在 Aloudata CAN 顶部导航栏选择指标应用，左边菜单栏选择 API 集成，在 API 集成界面获取；auth-value 请按 auth-type 填写对应认证值。

Body 请求参数

主表参数

参数	类型	是否必选	最大长度	描述
name	String	是	128	数据集名称，作为唯一标识，不可修改
displayName	String	是	128	数据集显示名称
description	String	否	256	数据集描述
sourceInfo	Object	是	-	来源数据信息，详见 sourceInfo 参数说明
defColumns	List	否	-	字段定义列表，详见 defColumns 参数说明。不传或传空时，系统会按数据源重新获取字段
relations	List	否	-	数据集主动关联关系列表
partitionMapping	Object	否	-	分区映射配置
filterExpr	String	否	-	数据集级过滤条件，推荐传表达式字符串

sourceInfo 参数说明

参数	类型	是否必选	最大长度	描述
name	String	是	128	来源数据名称
displayName	String	否	128	来源数据显示名称
description	String	否	256	来源数据描述
content	String	是	-	来源数据内容。物理表场景通常为表 guid 或完整表名
type	String	是	32	来源数据类型，枚举值：TABLE、SQL
datasourceName	String	否	128	数据源名称。当 type=SQL 时必填
datasourceItems	Array	是	-	数据源列表，仅支持 1 个元素，详见 datasourceItems 参数说明

datasourceItems 参数说明

参数	类型	是否必选	描述
id	String	是	数据源 guid
name	String	是	数据源名称
queryEngineType	String	是	查询引擎类型，如 AIR

defColumns 参数说明

参数	类型	是否必选	最大长度	描述
name	String	是	128	字段名称，不可修改
displayName	String	否	128	字段展示名称
description	String	否	256	字段描述
type	String	是	32	字段类型，枚举值：DIMENSION、MEASURE
originDataType	String	是	-	原始数据类型，如 DECIMAL、VARCHAR、TIMESTAMP
isHidden	Boolean	否	-	是否隐藏字段
isPartition	Boolean	否	-	是否为分区字段
isPrimaryKey	Boolean	否	-	是否为主键字段
sourceColumn	String	否	128	来源字段。物理表字段建议传入
expr	String	否	-	字段公式
partitionMapping	Object	否	-	字段级分区映射配置

响应参数

参数	类型	是否必选	描述
code	String	是	接口响应码
success	Boolean	是	请求是否成功
errorMsg	String	否	报错信息
detailErrorMsg	String	否	报错详情
traceId	String	是	跟踪 ID，用于问题排查
data	Boolean	是	是否修改成功

请求示例

{
  "name": "oracle_product_1",
  "displayName": "oracle_product_1",
  "description": "oracle_product_1",
  "sourceInfo": {
    "name": "TB_PRODUCT",
    "displayName": "TB_PRODUCT",
    "description": "",
    "content": "fenghou_air11.`anymetrics_oracle.ALOUDATA`.TB_PRODUCT",
    "type": "TABLE",
    "datasourceItems": [
      {
        "id": "fenghou_air11",
        "name": "fenghou_air11",
        "queryEngineType": "AIR"
      }
    ]
  },
  "defColumns": [
    {
      "name": "CATEGORY_ID",
      "displayName": "CATEGORY_ID",
      "originDataType": "DECIMAL",
      "description": null,
      "isPartition": false,
      "type": "MEASURE",
      "expr": "[TB_PRODUCT/CATEGORY_ID]",
      "sourceColumn": "CATEGORY_ID"
    },
    {
      "name": "time",
      "displayName": "time",
      "type": "DIMENSION",
      "description": "",
      "expr": "now()",
      "originDataType": "TIMESTAMP",
      "isPartition": false
    }
  ]
}

响应示例

{
  "data": true,
  "success": true,
  "code": "200",
  "errorMsg": null,
  "detailErrorMsg": null,
  "traceId": "f6e656798ed241c789f7132823c46c6b.141.17194028392300357"
}