跳转至

数据更新

概述

本接口用于更新该表相关物化表数据

接口 URL

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/scheduler/task/trigger

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

请求参数

公共请求参数(HEADERS)

参数 类型 是否必选 最大长度 描述
tenant-id String 32 租户ID,用于指标查询内容所在的租户
auth-type String 32 认证方式,用于设置身份认证方式 UID:使用 UID 进行身份认证TOKEN:使用 TOKEN 进行身份认证
auth-value String 32 UID或者TOKEN值,与auth-type 类型选择一致

公共参数获取方式

tenant-id 与 auth-value:在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成。在 API 集成界面获取取到tenant-id 与auth-value。

请求参数(Body)

参数名 类型 最大长度 必填 描述
tableName String 128 数据源表名称,需遵循 数据源名称组成规则(见下)。
tenantId String 128 租户 ID。
tablePartition String - 更新的分区名称,格式必须为 yyyy-MM-dd,例如:2024-07-17

数据源名称组成规则

tableName 的完整组成规则为:

数据源名称 + `catalog.schema`.表名

  • 数据源名称
    指在平台初始化时绑定数据源时指定的引擎自定义名称,例如:starrocksmysqloracle

注意:数据源名称并非数据库原生名字,而是绑定时的自定义名称。

  • catalog.schema
    必须使用反引号包裹 例如 `default_catalog.schema`

  • 表名
    实际业务表的名称。

示例

"tableName": "starrocks.`default_catalog.schema`.p_order"

  • starrocks → 数据源名称(平台绑定时的引擎自定义名)

  • default_catalog.schema → catalog 与 schema,使用反引号括起来

  • p_order → 表名

响应参数

参数名 类型 必填 最大长度 描述
code String 32 接口响应码(如 200 表示成功)。
succeed Boolean - 是否成功。
traceId String 128 请求的唯一追踪 ID,方便排查问题。
data String - 接口返回结果,通常为布尔值。
errorMsg String - 报错信息(若失败时返回)。

请求示例

{
    "tableName": "starrocks.`default_catalog.schema`.p_order",
    "tenantId": "tn_597771",
    "tablePartition": "2024-07-17"
}

响应示例

{
    "data": true,
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "16c08d170cc046cd81f0ebe81877dde8.156.17211863194670563"
}