获取标签列表
功能介绍
获取标签列表
URI
GET /v1.0/{project_id}/data/tags
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目id，获取方法请参见获取项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
workspace_id |
否 |
String |
工作空间id |
|
name |
否 |
String |
模糊查询：标签名称 |
|
limit |
否 |
Integer |
返回个数上限 |
|
offset |
否 |
Integer |
查询偏移量 |
|
ids |
否 |
String |
标签id列表，最多300个，逗号分隔 |
|
exact_name |
否 |
String |
精确匹配：标签名称 |
|
is_tag |
否 |
Boolean |
是否是标签，true：标签、false：分类名称 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
payload |
DataTagPayload object |
实际返回信息 |
|
meta_info |
RespMetaInfo object |
元数据 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
标签ID |
|
name |
String |
标签名称 |
|
description |
String |
标签描述 |
|
create_at |
Long |
创建时间，UTC标准时间毫秒时间戳 |
|
update_at |
Long |
更新时间，UTC标准时间毫秒时间戳 |
|
is_tag |
Boolean |
是否是标签，true：标签、false：分类名称 |
|
parent_id |
Integer |
父节点ID |
|
tag_level |
Integer |
标签等级 |
|
children_count |
Integer |
子节点个数 |
|
is_build_in |
Boolean |
是否内置标签 |
|
simulation_tags |
Array of integers |
仿真标签 |
|
workspace_id |
String |
工作空间id |
请求示例
获取标签列表
GET https://{endpoint}/v1.0/{project_id}/data/tags?limit=300&offset=0
响应示例
状态码：200
查询成功
{
"meta_info" : {
"current_time" : "2022-01-01T08:08:29Z"
},
"payload" : {
"list" : [ {
"id" : 0,
"name" : "tag1",
"description" : "",
"create_at" : 1640966400000,
"update_at" : 1640966400000,
"parent_id" : 0,
"tag_level" : 1,
"is_tag" : false,
"children_count" : 22,
"is_built_in" : false
} ],
"page_info" : {
"offset" : 0,
"limit" : 300,
"total" : 123
}
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询成功 |
|
400 |
请求参数错误 |
|
403 |
权限校验失败 |
|
500 |
系统内部错误 |
错误码
请参见错误码。
