更新时间:2025-11-21 GMT+08:00
分享

查询数据对象列表 - ListDatapanelObjects

功能介绍

查询数据对象列表

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/datapanel/{dataclass}/data-objects/search

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dataclass

String

数据类ID, 您可通过调用查询数据类列表接口获取数据类ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

String

参数解释:

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

limit

Integer

分页大小

offset

Integer

偏移量

sort_by

String

排序字段:create_time | update_time

order

String

排序方式:DESC | ASC

from_date

String

搜索开始时间,例如:2023-02-20T00:00:00.000Z

to_date

String

搜索结束时间,例如:2023-02-27T23:59:59.999Z

condition

condition object

搜索条件表达式

表4 condition

参数

是否必选

参数类型

描述

conditions

Array of conditions objects

表达式列表

logics

Array of strings

表达式名称列表

表5 conditions

参数

是否必选

参数类型

描述

name

String

表达式名称

data

Array of strings

表达式内容列表

响应参数

状态码:200

表6 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID

表7 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误信息

total

Integer

总数

limit

Integer

分页大小

offset

Integer

偏移量

success

Boolean

是否成功

data

Array of DataObjectDetail objects

详情列表

表8 DataObjectDetail

参数

参数类型

描述

create_time

String

记录时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区,无法解析时区的时间,默认时区填东八区

dataobject

Object

数据对象

dataclass_ref

dataclass_ref object

数据类对象

format_version

Integer

格式版本

id

String

事件唯一标识,UUID格式,最大36个字符

project_id

String

当前项目的id

update_time

String

更新时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区,无法解析时区的时间,默认时区填东八区

version

Integer

版本

workspace_id

String

当前的工作空间id

表9 dataclass_ref

参数

参数类型

描述

id

String

数据类唯一标识,UUID格式,最大36个字符

name

String

数据类名称

状态码:400

表10 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID

表11 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

响应成功返回对象

400

响应错误返回对象

错误码

请参见错误码

相关文档