文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 资源公共查询/ 查询仪表板或者大屏列表
更新时间：2025-03-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询仪表板或者大屏列表

功能介绍

仪表板和大屏资源统一。

URI

GET /v1/{project_id}/resources/{resource_type}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。

resource_type

是

String

参数解释：

资源类型枚举值，用于指定授权对象的类型。

示例：datasource，指定授权对象类型为数据源。

约束限制：

不涉及

取值范围：

以下枚举值：

  • datasource：数据源；
  • dataset：数据集；
  • metric：指标；
  • dashboard：仪表板；
  • screen：大屏；
  • embedAnalysis：嵌入分析；
  • portal：数据门户；
  • subject：智能分析助手。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移值。

limit

否

Integer

返回列表数量。

sort_key

否

String

排序字段。

sort_dir

否

String

排序类别：

  • desc：倒序。
  • asc：正序。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

是

String

工作空间ID。获取方法请参见获取工作空间ID。

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总数。

page_data

Array of 表5 objects

分页数据。
表5 ResourceVO

参数

参数类型

描述

id

String

-

name

String

资源名称。

create_user_name

String

创建者。

create_date

Integer

创建日期。

update_user_name

String

更新者。

update_date

Integer

更新日期。

status

Integer

发布状态。

请求示例

获取大屏资源列表。

GET https://{endpoint}/v1/0e****127d****6b7****95750da/resources/screen

响应示例

状态码： 200

查询资源列表成功。

{
  "count" : 1,
  "page_data" : [ {
    "id" : "e2xxxx66f-81bxxxxxx9c38-80xxx0fxx9c84",
    "name" : "未命名大屏1",
    "create_user_name" : "dat***ig***",
    "create_date" : 1707215155901,
    "update_user_name" : "dat***ig***",
    "update_date" : 1707215155901,
    "status" : 0
  } ]
}

状态码

状态码

描述

200

查询资源列表成功。

错误码

请参见错误码。

父主题： 资源公共查询

相关文档