跳转至

查询物化方案列表

接口描述

本接口用于分页查询当前租户下已创建的物化方案列表

接口 URL

POST /anymetrics/api/v1/accelerate/plan/queryAccelerateResultPlanList

请求参数

公共请求参数(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 类型选择一致

公共参数获取方式

前往 Aloudata CAN「指标应用」→「API 集成」中查看。

image.png

请求参数

字段 类型 是否必选 描述
materializeType String 按物化类型筛选:ACCELERATERESULTEXTERNAL
pager Object 分页参数

pager 内部结构

字段 类型 是否必选 描述
pageNumber Integer 页码,从 1 开始
pageSize Integer 每页大小

请求示例

{
  "materializeType": "EXTERNAL",
  "pager": {
    "pageNumber": 1,
    "pageSize": 20
  }
}

响应参数说明

data(方案数组)

字段 类型 描述
id String 方案 uuid
name String 方案英文名
displayName String 中文展示名
materializeType String 物化方案类型

分页字段

字段 类型 描述
hasNext Boolean 是否有下一页
total Integer 总记录条数
pageNumber Integer 当前页
pageSize Integer 每页大小

响应示例

{
  "data": [
    {
      "id": "ecfc2a9539a04ef49897a9b4e3d65e7f",
      "name": "external_test",
      "displayName": "外挂物化测试",
      "materializeType": "EXTERNAL"
    },
    {
      "id": "asd2229539a04ef49897a9b4e3d6bbb1",
      "name": "result_demo",
      "displayName": "结果物化测试",
      "materializeType": "RESULT"
    }
  ],
  "hasNext": false,
  "total": 2,
  "pageNumber": 1,
  "pageSize": 20
}