获取通用存储的数据列表-GetDataWarehouseDataList
功能介绍
获取通用存储的数据列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:dataWarehouse:list
List
workspace *
-
-
-
URI
POST /v1.0/{project_id}/common/warehouses/{data_warehouse_id}/data
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 只能用小写字母 a-z 和数字 0-9组成,且长度为32个字符 默认取值: 不涉及 |
| data_warehouse_id | 是 | String | 参数解释: 通用存储id 约束限制: 不涉及 取值范围: 标准36位带横杠、小写UUID 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释: 查询偏移量 约束限制: 与limit配合使用 取值范围: 最小值为0 默认取值: 0 |
| limit | 否 | Integer | 参数解释: 返回个数上限 约束限制: 与offset配合使用 取值范围: 最小值为1,最大值为100 默认取值: 10 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 内容类型。填application/json 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| create_time_order | 否 | String | 参数解释: 创建时间排序 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| file_name_order | 否 | String | 参数解释: 文件名排序 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| data_process_task_ids | 否 | Array of strings | 参数解释: 数据处理任务id列表 约束限制: 不涉及 |
| raw_data_ids | 否 | Array of strings | 参数解释: 数据包ids 约束限制: 不涉及 |
| start_time | 否 | Long | 参数解释: 开始时间,UTC标准时间毫秒时间戳 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| end_time | 否 | Long | 参数解释: 结束时间,UTC标准时间毫秒时间戳 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| file_name | 否 | String | 参数解释: 文件名 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| file_types | 否 | Array of strings | 参数解释: 文件类型 约束限制: 不涉及 |
| and_tags | 否 | Array of strings | 参数解释: tag id,多选,且 约束限制: 不涉及 |
| or_tags | 否 | Array of strings | 参数解释: tag id,多选,或 约束限制: 不涉及 |
| and_custom_attributes | 否 | Array of strings | 参数解释: 自定义查询条件 id,多选,且 约束限制: 不涉及 |
| or_custom_attributes | 否 | Array of strings | 参数解释: 自定义查询条件 id,多选,或 约束限制: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| payload | FileDataInfoPayload object | 参数解释: 实际返回信息 |
| meta_info | MetaInfo object | 参数解释: 元数据 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| list | Array of FileDataInfo objects | 参数解释: 通用存储的数据列表 |
| page_info | PageInfo object | 参数解释: 分页信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: id 取值范围: 不涉及 |
| sort | Array of strings | 参数解释: es 排序 |
| file_folder_path | String | 参数解释: 文件夹路径 取值范围: 不涉及 |
| file_name | String | 参数解释: 文件名 取值范围: 不涉及 |
| file_type | String | 参数解释: 文件类型 取值范围: |
| data_warehouse_id | String | 参数解释: 通用存储id 取值范围: 不涉及 |
| raw_data_id | String | 参数解释: 原始数据id 取值范围: 不涉及 |
| data_process_task_id | String | 参数解释: 数据处理任务id 取值范围: 不涉及 |
| create_at | String | 参数解释: 创建时间,UTC标准时间毫秒时间戳 取值范围: 不涉及 |
| tags | Array of strings | 参数解释: 标签列表 |
| custom_attributes | Array of Map<String,String> objects | 参数解释: 自定义属性列表 |
请求示例
获取通用存储的数据列表
POST https://{endpoint}/v1.0/{project_id}/common/warehouses/ee9784a5-dde5-4a47-a006-fac074c5bee8/data?offset=0&limit=10
{
"data_process_task_ids" : [ "frame-extract-2077" ],
"and_tags" : [ 956 ],
"and_custom_attributes" : [ "91b64ba4-94ed-445c-96c5-cec74e75555b" ],
"file_types" : [ "TEXT", "IMAGE" ],
"start_time" : 1701360000000,
"end_time" : 1701532799999,
"file_name" : "file"
} 响应示例
状态码:200
查询成功
获取通用存储的数据列表
{
"meta_info" : {
"current_time" : "2024-01-02T02:04:22Z"
},
"payload" : {
"list" : [ {
"id" : "APRnj4wBXQ6dkLNQrdKX",
"sort" : [ 1703212985450 ],
"file_name" : "file_name",
"file_type" : "IMAGE",
"data_warehouse_id" : "ee9784a5-dde5-4a47-a006-fac074c5bee8",
"raw_data_id" : "DPK0003929",
"data_process_task_id" : "frame-extract-2077",
"file_folder_path" : "frame-extract-2077/camera_1_1698388637796/",
"tags" : [ ],
"custom_attributes" : [ ],
"create_at" : 1701224873612
} ],
"page_info" : {
"total" : 1,
"offset" : 0,
"limit" : 1
}
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
| 400 | 参数校验失败 |
| 500 | 系统内部错误 |
错误码
请参见错误码。