跳转至

修改指标视图

接口描述

本接口用于实现指标视图的更新功能,允许用户对已存在的指标视图进行配置上的修改。通过传递详细的视图配置信息,接口能够有效地调整视图的结构、所涉及的指标、维度、筛选条件等。

接口URL

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

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。

请求参数

参数 类型 是否必选 最大长度 描述
id Long 指标视图id
viewName String 50 指标视图名称
displayName String 指标视图展示名
description String 指标视图描述
metrics Array[String] 指标列表
dimensions Array[String] 维度列表
filters Array[String] 筛选器
time_constraint String 日期范围
orders Array[String] 查询的排序规则。引用的维度需要包含在“dimensions”参数中。

响应参数

参数 类型 是否必选 最大长度 描述
code String 32 接口响应码
message String 512 消息体
traceId String 128 跟踪ID,用于问题排查
data Boolean 操作结果

请求示例

{
  "id": 463,
  "viewName": "biuse_11",
  "description": "",
  "metrics": [
    "6b219c300d45496297f7f191ba99e91a"
  ],
  "dimensions": [
    "metric_time__day"
  ],
  "timeConstraint": null,
  "filters": [],
  "orders": [],
  "createFrom": "WEBUI",
  "categoryId": "71324644-9512-41a3-821b-86c031798b58",
  "displayName": "BI看",
  "metricDefinitions": {},
  "displayNameMap": null
}

响应示例

{
    "code":"200",
    "message":"请求成功",
    "traceId":"fdde6861bd554805998343f9ff2dcd70.292.16857691758642861",
    "data":true
}