文档首页/ IoT数据分析 IoTA/ API参考/ API列表/ 存储组管理/ 查询存储组列表
更新时间：2022-07-13 GMT+08:00
查看PDF
分享

查询存储组列表

功能介绍

查询存储组列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/data-store-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

最小长度：1

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

unit

否

String

存储用量单位

最小长度：0

最大长度：64

枚举值：

  • MB

type

否

String

存储类型，有资产存储(取值:AssetStorage)、设备存储(取值:DeviceStorage)两种类型

最小长度：0

最大长度：64

group_id

否

String

存储组 ID

最小长度：1

最大长度：64

name

否

String

存储组名称

最小长度：0

最大长度：64

offset

否

Integer

偏移量，表示从此偏移量开始查询，offset 大于等于 0

最小值：0

最大值：0

limit

否

Integer

返回条数限制

最小值：200

最大值：200

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

租户Token

最小长度：1

最大长度：65535

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

groups

Array of GetGroup objects

存储组列表

count

Integer

返回的 data-store-group 数量

最小值：0

最大值：4
表5 GetGroup

参数

参数类型

描述

group_id

String

存储组 ID

最小长度：0

最大长度：64

name

String

存储组名称

最小长度：0

最大长度：64

description

String

描述

最小长度：0

最大长度：1024

warm_data_usage

Long

温数据存储用量

最小值：0

最大值：1099511627776

data_store_count

Long

此存储组下存储实例的个数

最小值：0

最大值：1024

cold_data_usage

Long

冷数据存储用量

最小值：0

最大值：1099511627776

warm_data_retention_policy

String

温数据老化策略，单位只支持d（天），且只支持整数，如365天则可配置为“365d”，如“365h”或“360.5d”等均不被支持

最小长度：0

最大长度：64

cold_data_retention_policy

String

冷数据老化策略，单位只支持d（天），且只支持整数，如365天则可配置为“365d”，如“365h”或“360.5d”等均不被支持

最小长度：0

最大长度：64

created_time

String

创建时间

最小长度：0

最大长度：64

modified_time

String

修改时间

最小长度：0

最大长度：64

type

String

存储类型，有资产存储(取值:AssetStorage)、设备存储(取值:DeviceStorage)两种类型

最小长度：0

最大长度：64

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

最小长度：0

最大长度：100

error_msg

String

错误消息

最小长度：0

最大长度：1024

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

最小长度：0

最大长度：100

error_msg

String

错误消息

最小长度：0

最大长度：1024

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

最小长度：0

最大长度：100

error_msg

String

错误消息

最小长度：0

最大长度：1024

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

最小长度：0

最大长度：100

error_msg

String

错误消息

最小长度：0

最大长度：1024

请求示例

无

响应示例

状态码： 200

OK

{
  "groups" : [ {
    "group_id" : "0fba303d-687f-447c-9c54-999156867cf9",
    "name" : "dataStoreGroup1",
    "description" : "some description about this group",
    "data_store_count" : 0,
    "warm_data_retention_policy" : "7d",
    "created_time" : "2020-08-14T23:21:49Z",
    "modified_time" : "2020-08-14T23:21:49Z",
    "type" : "DeviceStorage"
  } ],
  "count" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题： 存储组管理

相关文档