查询存储列表

功能介绍

查询存储列表

调试

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

URI

GET /v1/{project_id}/data-stores

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目 ID 最小长度：1 最大长度：128

表2 Query参数
参数	是否必选	参数类型	描述
group_id	否	String	存储组 ID 最小长度：0 最大长度：64
data_store_id	否	String	存储 ID 最小长度：0 最大长度：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参数
参数	参数类型	描述
data_stores	Array of GetDataStore objects	数据结构列表
count	Integer	返回的 data-store 数量最小值：0 最大值：200

表5 GetDataStore
参数	参数类型	描述
data_store_id	String	存储 ID 最小长度：0 最大长度：64
name	String	存储名称最小长度：0 最大长度：64
group_id	String	存储 ID 最小长度：0 最大长度：64
tags	Array of Tag objects	标签
metrics	Array of Metric objects	指标
properties	Array of Property objects	属性
created_time	String	创建时间最小长度：0 最大长度：64
modified_time	String	更新时间最小长度：0 最大长度：64

表6 Tag
参数	参数类型	描述
name	String	标签名称最小长度：0 最大长度：64
description	String	标签描述最小长度：0 最大长度：64

表7 Metric
参数	参数类型	描述
name	String	指标名称最小长度：0 最大长度：64
type	String	指标值类型最小长度：0 最大长度：64
description	String	指标描述最小长度：0 最大长度：64
unit	String	指标单位最小长度：0 最大长度：64

表8 Property
参数	参数类型	描述
name	String	属性名称最小长度：0 最大长度：64
type	String	属性值类型最小长度：0 最大长度：64
description	String	属性描述最小长度：0 最大长度：64
unit	String	属性单位最小长度：0 最大长度：64

状态码： 400

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误编码最小长度：0 最大长度：100
error_msg	String	错误消息最小长度：0 最大长度：1024

状态码： 401

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误编码最小长度：0 最大长度：100
error_msg	String	错误消息最小长度：0 最大长度：1024

状态码： 403

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误编码最小长度：0 最大长度：100
error_msg	String	错误消息最小长度：0 最大长度：1024

状态码： 500

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误编码最小长度：0 最大长度：100
error_msg	String	错误消息最小长度：0 最大长度：1024

请求示例

无

响应示例

状态码： 200

{
  "data_stores" : [ {
    "data_store_id" : "47fc262a-5cce-4a47-a17d-392498d36948",
    "name" : "SmokeDetector_Storage",
    "group_id" : "0fba303d-687f-447c-9c54-999156867cf9",
    "tags" : [ [ {
      "name" : "device_id"
    }, {
      "name" : "category"
    } ] ],
    "properties" : [ {
      "name" : "temperature",
      "type" : "double"
    } ],
    "created_time" : "2020-08-14T23:21:49Z",
    "modified_time" : "2020-08-14T23:21:49Z"
  } ],
  "count" : 1
}