跳转至

指标视图详情查询

接口说明

本接口适用于根据指标视图名称来查询指标视图的配置信息。

接口URL

GET Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/analysisview/queryByName?viewName = newView

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。

请求参数

参数 类型 是否必选 最大长度 描述
viewName String 指标视图名称

响应参数

参数 类型 是否必选 最大长度 描述
id Long 指标视图id
viewName String 指标视图名称
displayName String 中文名
description String 描述
metrics Array 指标列表
dimensions Array 维度列表
timeConstraint String 时间限定
filters Array 过滤器列表
orders Array 排序列表
createFrom String 创建来源

请求示例

http://127.0.0.1/anymetrics/api/v1/analysisview/queryByName?viewName=viewName_6da0cde1a773

响应示例

{
  "id": 0,
  "viewName": "viewName_6da0cde1a773",
  "displayName":"中文名",
  "description": "description_facf594a8f5a",
  "metrics": [
    "metrics_24f597e4ee0a"
  ],
  "dimensions": [
    "dimensions_5b28dbdcdb47"
  ],
  "timeConstraint": "timeConstraint_0616f4288352",
  "filters": [
    "filters_0367634f941b"
  ],
  "orders": [
    {}
  ],
  "createFrom": "创建来源"
}