获取通用存储列表信息-GetGeneralStorageListInformation

功能介绍

获取通用存储列表

URI

GET /v1.0/{project_id}/common/warehouses

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目id，获取方法请参见获取项目ID

表2 Query参数
参数	是否必选	参数类型	描述
name	否	String	根据名称模糊查询
offset	否	Integer	查询偏移量
limit	否	Integer	返回个数上限
workspace_id	是	String	工作空间id

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
payload	listDataWarehousePayload object	实际返回信息
meta_info	MetaInfo object	元数据

表5 listDataWarehousePayload
参数	参数类型	描述
page_info	PageInfo object	分页信息
list	Array of DataWarehouseDto objects	通用存储列表信息

表6 PageInfo
参数	参数类型	描述
total	Long	资源总数
offset	Long	查询偏移量
limit	Long	返回个数上限

表7 DataWarehouseDto
参数	参数类型	描述
id	String	通用存储id
name	String	名称
description	String	描述
workspace_id	String	工作空间id
project_id	String	项目id
create_time	Long	创建时间，UTC标准时间毫秒时间戳
object_count	Long	对象数量
raw_data_count	Long	数据包数量

表8 MetaInfo
参数	参数类型	描述
current_time	String	请求时间，UTC时间格式，时间为UTC标准时间

请求示例

获取通用存储列表信息

GET https://{endpoint}/v1.0/{project_id}/common/warehouses?offset=0&limit=10&name=warehouse_name&workspace_id=0

响应示例

状态码：200

查询成功

获取通用存储列表信息

{
  "meta_info" : {
    "current_time" : "2024-01-02T02:04:22Z"
  },
  "payload" : {
    "list" : [ {
      "id" : "ee9784a5-dde5-4a47-a006-fac074c5bee8",
      "name" : "WAREHOUSE_NAME",
      "description" : "仓库1",
      "create_at" : 1701170680048,
      "object_count" : 317,
      "raw_data_count" : 4
    } ],
    "page_info" : {
      "total" : 1,
      "offset" : 0,
      "limit" : 10
    }
  }
}