查询标签的值列表
功能介绍
查询标签的值列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/data-stores/{data_store_id}/tags/{tag_name}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID 最小长度:1 最大长度:128 |
|
data_store_id |
是 |
String |
存储ID 最小长度:1 最大长度:64 |
|
tag_name |
是 |
String |
tag 名称,例如:deviceId 最小长度:1 最大长度:64 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
filters |
否 |
String |
查询标签的值的过滤条件,例如: {"deviceCategory": "class1"},注意特殊字符需要 urlencode 最小长度:0 最大长度:1024 |
|
offset |
否 |
Integer |
查询起始元素的偏移 最小值:0 最大值:2000 缺省值:0 |
|
limit |
否 |
Integer |
返回的元素列表大小限制,默认为 100 最小值:1 最大值:2000 缺省值:100 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
租户Token 最小长度:1 最大长度:65535 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
tag_name |
String |
标签的名称 最小长度:1 最大长度:64 |
|
tag_values |
Array of strings |
标签的值列表 |
|
count |
Integer |
当前列表元素总数 最小值:0 最大值:2000 |
状态码: 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误编码 |
|
error_msg |
String |
错误消息 |
状态码: 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误编码 |
|
error_msg |
String |
错误消息 |
状态码: 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误编码 |
|
error_msg |
String |
错误消息 |
状态码: 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误编码 |
|
error_msg |
String |
错误消息 |
请求示例
无
响应示例
状态码: 200
OK
{
"tag_name" : "deviceId",
"tag_values" : [ "device_1", "device_2", "device_3" ],
"count" : 3
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal Server Error |
错误码
请参见错误码。