跳转至

修改数据集

接口说明

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

接口URL

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

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。

image.png

请求参数

主表:请求参数总览

参数 类型 是否必选 最大长度 描述
name String 128 数据集名称(不可修改)
displayName String 128 数据集显示名称
description String 256 数据集描述
sourceInfo Object - 来源数据信息(详见子表 1)
defColumns List - 字段定义列表(详见子表 2)

子表 1:sourceInfo 参数详情

子参数 类型 是否必选 最大长度 描述
name String 128 来源数据名称
content String - 来源数据内容(物理表时为表 guid)
type String 32 来源数据类型(枚举值:TABLE/SQL)
datasourceName String 128 数据源名称(当 type=SQL 时必填)
datasourceItems Array - 数据源列表(仅支持 1 个元素,详见子表 1-1)

子表 1-1:datasourceItems 参数详情

子参数 类型 是否必选 描述
id String 数据源 guid
name String 数据源名字
queryEngineType String 数据源类型(如 AIR)

子表 2:defColumns 参数详情

子参数 类型 是否必选 最大长度 描述
name String 128 字段名称(不可修改)
displayName String 128 字段展示名称
description String 256 列描述
type String 32 列类型(枚举值:DIMENSION/MEASURE)
originDataType String - 原始数据类型(如 DECIMAL)
isPartition Boolean - 是否为分区字段
expr String - 字段公式(如[TB_PRODUCT/ID])
sourceColumn String 128 来源字段(物理表字段时必填)

响应参数

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

入参实例

{
    "defColumns":[
        {
            "name":"CATEGORY_ID",
            "originDataType":"DECIMAL",
            "description":null,
            "isPartition":false,
            "type":"MEASURE",
            "expr":"[TB_PRODUCT/CATEGORY_ID]",
            "sourceColumn":"CATEGORY_ID"
        },
        {
            "name":"time",
            "type":"DIMENSION",
            "description":"",
            "expr":"now()",
            "originDataType":"TIMESTAMP",
            "isPartition":false
        }
    ],
    "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"
            }
        ]
    }
}