跳转至

指标视图列表树状结构

接口说明

本接口是用于获取树状结构的指标视图列表

接口URL

GET Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/analysisview/treeList

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

请求参数

公共请求参数(HEADERS)

参数 类型 是否必选 描述
tenant-id String 租户ID,用于指标查询内容所在的租户
auth-type String 认证方式,用于设置身份认证方式
UID:使用 UID 进行身份认证
TOKEN:使用 TOKEN 进行身份认证
ACCOUNT:使用ACCOUNT 进行身份认证
APIKEY:使用APIKEY 进行身份认证,详情见:API Key 管理
auth-value String UID、TOKEN值、ACCOUNT,与auth-type 类型选择一致

公共参数获取方式

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

请求参数

响应参数

参数 类型 是否必选 最大长度 描述
categoryId String 当前目录id
categoryName String 当前目录名称
analysisViewList Array analysisView信息
subCategory Array 子目录列表,递归结构

analysisView信息

参数 类型 是否必选 最大长度 描述
id Integer 指标视图id
viewName String 50 指标视图名称
displayName String 指标视图中文名
description String 300 指标视图描述

请求示例

http://127.0.0.1/anymetrics/api/v1/analysisview/treeList

响应示例

[
  {
  "categoryId": "category123", // 当前目录id
  "categoryName": "Category Name", // 当前目录名称
  "analysisViewList": [
    {
      "id": 226,
      "analysisViewName": "Analysis 1",
      "cnName":"中文名",
      "description": "Description of Analysis 1"
    },
    {
      "id": 227,
      "analysisName": "Analysis 2",
      "cnName":"中文名",
      "description": "Description of Analysis 2"
    }
  ], //指标视图列表
  "subCategory": [
    {
      "categoryId": "subCategory123",
      "categoryName": "Subcategory Name",
      "analysisViewList": [
        {
          "id": 228,
          "analysisName": "Subanalysis 1",
          "cnName":"中文名",
          "description": "Description of Subanalysis 1",
        }
      ],
      "subCategory": []
    }
  ] // 子目录资源
}
]