跳转至

创建外挂加速方案

接口描述

本接口是外挂物化方案创建流程中最核心的步骤,用于保存已经拆分好的指标、维度、物化表结构、调度展示配置等信息,并最终生成一个物化方案。在调用本接口之前,必须先调用 指标拆分接口 splitMetric,以获取完整指标结构及拆分指标 ID。

接口 URL

POST /anymetrics/api/v1/accelerate/plan/createAccelerateResultPlan

请求参数

公共请求参数(HEADERS)

参数 类型 是否必选 最大长度 描述
tenant-id String 32 租户 ID,用于指定业务空间
auth-type String 32 认证方式:UID / TOKEN
auth-value String 32 对应 auth-type 的认证值

公共参数获取方式

可在 Aloudata CAN 顶部导航「指标应用」→ 左侧「API 集成」中查看。

image.png

请求参数

字段 类型 是否必选 描述
materializeType String 物化类型,必须为 "EXTERNAL"
tablePath Object 物化表目标路径(catalog/schema/tableName)
metrics List 原始指标列表
dimensions List 原始维度列表
mtConfig Object 物化表字段配置(包含原始 + 拆分指标)
metricEntityList List 指标可上卷维度配置
refreshConfig Object 刷新配置(仅 UI 展示,不会执行)
timeConstraint String 指标日期筛选表达式
metricDefinitions Map 原始指标快速衍生
metricTimeFilters String 按 code 编写的指标日期过滤
dimensionFilters List 按维度 code 编写的维度过滤
name String 方案英文名
displayName String 方案中文名
categoryId String 类目 ID

请求示例

{
  "name":"waigua",
  "displayName":"外挂",
  "materializeType": "EXTERNAL",
  "tablePath": {
    "tableCatalog":"default_catalog",
    "tableSchema":"aloudatacan",
    "tableName":"jiasu_table1"
  },
  "metrics": [
    { "name": "avg_order_amount" },
    { "name": "sum_order_amount" }
  ],
  "dimensions": [
    { "name": "metric_time__DAY" },
    { "name": "username" }
  ],
  "mtConfig": {
    "columnConfigs": [
      { "id": "mc99aca41a3824cb9ca79ada4c70208b", "type": "METRIC", "name": "sum_order_amount_111" },
      { "id": "mce5493438bb57b4e71b087aead42a03", "type": "METRIC", "name": "avg_order_amount_112" },
      { "id": "fe8c75ce30ff36b9ae92aa35f5fcce85", "type": "METRIC", "name": "avg_order_amount_sum_113" },
      { "id": "6e1b93fb4b5d6299cce9471f2abd6604", "type": "METRIC", "name": "avg_order_amount_count_114" },
      { "type": "DIMENSION", "id": "dmb9b604484bd9f5dd9bb8f1a2f22cb7", "name": "username_115" },
      { "type": "DIMENSION", "id": "metric_time__day", "name": "metric_time_115" }
    ]
  },
  "metricEntityList": [
    {
      "id": "mce5493438bb57b4e71b087aead42a03",
      "code": "mce5493438bb57b4e71b087aead42a03",
      "actualDimensionList": ["metric_time__day"]
    },
    {
      "id": "fe8c75ce30ff36b9ae92aa35f5fcce85",
      "code": null,
      "actualDimensionList": ["metric_time__day"]
    }
  ],
  "refreshConfig": {
    "isFullRefresh": false,
    "granularity": "DAY",
    "updateUpperInterval": -1,
    "updateLowerInterval": -3,
    "isScheduleUpdate": true,
    "cron": "0 0 0 * * ?"
  }
}

响应参数

字段名 类型 描述
uuid String 方案唯一标识
name String 英文名
displayName String 中文展示名

响应示例

{
  "uuid": "ecfc2a9539a04ef49897a9b4e3d65e7f",
  "name": "chaifen_test",
  "displayName": "拆分测试"
}

使用说明

  • metrics 与 dimensions 仅填写原始指标与原始维度
    拆分指标不得写入这两个字段。

  • mtConfig 必须包含所有字段(原始 + 拆分)
    且每个字段必须有唯一的列名,否则保存失败。

  • 物化表不会自动创建
    用户需使用 /queryReferenceScript 中的 DDL 自行建表。

  • refreshConfig 仅用于页面展示
    系统不会自动调度外挂物化任务。