跳转至

查询物化方案详情

接口描述

本接口用于查询指定物化方案(包括外挂物化 EXTERNAL)的完整配置信息。
用户可根据返回的指标、维度、列映射、调度信息等内容,了解当前方案的整体结构:输入为方案的 uuid,这是保存方案时系统返回的唯一标识。

接口 URL

GET /anymetrics/api/v1/accelerate/plan/queryAccelerateResultPlan

请求参数

公共请求参数(HEADERS)

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

公共参数获取方式

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

image.png

请求参数

字段 类型 是否必选 描述
uuid String 要查询的物化方案唯一 ID

请求示例

GET /anymetrics/api/v1/accelerate/plan/queryAccelerateResultPlan?uuid=ecfc2a9539a04ef49897a9b4e3d65e7f

响应参数说明

字段 类型 描述
id String 方案 uuid
name String 方案英文名
displayName String 中文展示名
tablePath Object tableCatalog / tableSchema / tableName
materializeType String 物化类型(EXTERNAL)
metricTimeGranularity String 指标日期粒度,例如 DAY / MONTH
metricEntityList List 每个指标的可上卷维度配置
mtConfig Object 物化表字段配置(列名、字段 ID、类型)
metricList List 原始指标 code 列表
dimensionList List 原始维度 code 列表
timeConstraint String / List 指标日期筛选条件
dimensionFilters List 维度筛选条件
refreshConfig Object 刷新配置(仅显示用途)

响应示例

{
  "id": "ecfc2a9539a04ef49897a9b4e3d65e7f",
  "name": "chaifen_test",
  "displayName": "chaifen_ceshi",
  "tablePath": {
    "tableCatalog":"default_catalog",
    "tableSchema":"aloudatacan",
    "tableName":"jiasu_table1"
  },
  "materializeType": "EXTERNAL",
  "metricTimeGranularity": "DAY",
  "metricEntityList": [
    {
      "id": "METRIC_mce5493438bb57b4e71b087aead42a03_nSEdsReGdDNMYytI",
      "code": "mce5493438bb57b4e71b087aead42a03",
      "actualDimensionList": [
        "DIMENSION_metric_time_PyYVQUjhwHwzlQYV",
        "DIMENSION_dmb9b604484bd9f5dd9bb8f1a2f22cb7_RZbLQxGfStRjSnuf"
      ]
    }
  ],
  "mtConfig": {
    "columnConfigs":[
      {
        "id": "METRIC_mce5493438bb57b4e71b087aead42a03_nSEdsReGdDNMYytI",
        "type": "METRIC",
        "name": "avg_order_amount"
      },
      {
        "type": "DIMENSION",
        "id": "DIMENSION_dmb9b604484bd9f5dd9bb8f1a2f22cb7_RZbLQxGfStRjSnuf",
        "name": "username"
      }
    ]
  },
  "metricList": ["mce5493438bb57b4e71b087aead42a03"],
  "dimensionList": ["dmb9b604484bd9f5dd9bb8f1a2f22cb7"],
  "timeConstraint": ["CAST(metric_time AS DATE) >= '2025-01-01'"],
  "dimensionFilters": ["username != ''"],
  "refreshConfig": {
    "isFullRefresh":false,
    "granularity": "DAY",
    "updateUpperInterval": -1,
    "updateLowerInterval": -3,
    "isScheduleUpdate": true,
    "cron": "0 0 0 * * ?"
  }
}