跳转至

创建结果加速方案

接口说明

本接口用于在 Aloudata CAN 平台上创建应用加速。

接口URL

POST http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/accelerate/plan/create/app

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

请求参数

公共请求参数

参数 类型 是否必选 最大长度 描述
tenant-id String 32 租户ID,用于指标查询内容所在的租户
auth-type String 32 认证方式支持:UID(基于用户ID认证)TOKEN(基于令牌认证)。
auth-value String 32 与选定的auth-type相对应的认证值。

请求参数

分类 参数 类型 必选 描述
基本信息 name String 方案名称(字母开头,仅字母/数字/下划线,同时作为物化表名称,不可修改
displayName String 结果加速展示名
加速内容 metrics Array 指标名称列表,参考指标数据查询 API-metrics章节
dimensions Array 维度列表,参考指标数据查询 API-dimensions章节
metricDefinitions Map 临时指标定义,参考指标数据查询 API-metricDefinitions章节
filters Array 维度过滤表达式(全局筛选),参考指标数据查询 API-filters
timeConstraint String 时间筛选表达式(仅支持 metric_time),参考指标数据查询 API-timeConstraint 章节
granularity String 时间粒度,应与指标日期粒度一致
更新周期 isScheduleUpdate Boolean 是否启用定时调度:true = 定时更新;false = 依赖触发更新(默认)
cron String 定时更新 Cron 表达式(当 isScheduleUpdate = true 时必填)
更新方式 isFullRefresh Boolean 是否全量更新:true = 全量;false = 增量
updateLowerInterval Integer 当 isFullRefresh = false 时必选 更新时间偏移下界,例如 -1 表示“更新昨天的数据”
updateUpperInterval Integer 当 isFullRefresh = false 时必选 更新时间偏移上界
失败策略 retryCount Integer 重试次数
retryInterval Integer 重试时间间隔(分钟)

默认设置说明

  • 更新周期为依赖更新

  • 通知关闭

  • 更新失败策略为终止

响应参数

参数 类型 是否必选 描述
success Boolean 是否请求成功
code String 接口响应码
errorMsg String 报错信息
detailErrorMsg String 报错详情
traceId String 跟踪ID,用于问题排查
data Object
planId String 方案ID
name String 加速方案名称
displayName String 加速方案展示名称

请求示例

{
    "name":"acc_plus_api_6",
    "displayName":"acc_plus_api_6",
    "dimensions":[
        "metric_time__15minute"
    ],
    "metrics": [
        "count_order_datetime__period__dt15min",
        "c_order_count_per_user2"
    ],
    "metricDefinitions": {
        "c_order_count_per_user2": {
            "refMetric": "count_order_datetime",
            "filters": [
                "IN(['province'],\"浙江6\")"
            ],
            "indirections":[
                "sameperiod__mom__growthvalue"
            ]
        }
    },
    "filters": [],
    "timeConstraint": "[metric_time__day] = DATE(\"2024-10-14\")",
    "updateUpperInterval": 0,
    "updateLowerInterval": 0,
    "granularity": "MINUTE",
    "isScheduleUpdate": true,
    "cron": "* 13,28,43,58 0/1 * * ?",
    "isFullRefresh": false
}

响应示例

{
    "data": {
        "planId": "result_925ebd1a9aad17916b56537fb16cb37f",
        "name": "acc_plus_api_6",
        "displayName": "acc_plus_api_6"
    },
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "e79935618aa340b8a63d397d8fd4f02a.323.17308857201550033"
}