获取标签列表-GetTagList
功能介绍
获取标签列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:dataTag:list
List
workspace *
-
-
-
URI
GET /v1.0/{project_id}/data/tags
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 否 | String | 参数解释: 工作空间ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
| name | 否 | String | 参数解释: 模糊查询:标签名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 列表返回的最大记录数 约束限制: 最小为1,最大为300 取值范围: 不涉及 默认取值: 300 |
| offset | 否 | Integer | 参数解释: 查询偏移量,与limit配合使用。假如设置offset为11,limit为10,即从第12条数据开始查询,一次最多读取10条记录。当offset超过总记录数时,列表返回为空 约束限制: 最小值0 取值范围: 不涉及 默认取值: 0 |
| ids | 否 | String | 参数解释: 标签ID列表,最多300个,逗号分隔 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| exact_name | 否 | String | 参数解释: 精确匹配:标签名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| is_tag | 否 | Boolean | 参数解释: 是否是标签 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 是 | String | 参数解释: 内容类型。填application/json 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| payload | DataTagPayload object | 参数解释: 实际返回信息 |
| meta_info | RespMetaInfo object | 参数解释: 元数据 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| list | Array of DataTagVo objects | 参数解释: 标签列表 |
| page_info | PageInfo object | 参数解释: 分页信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Integer | 参数解释: 标签ID 取值范围: 不涉及 |
| name | String | 参数解释: 标签名称 取值范围: 不涉及 |
| description | String | 参数解释: 标签描述 取值范围: 不涉及 |
| create_at | Long | 参数解释: 创建时间,UTC标准时间毫秒时间戳 取值范围: 不涉及 |
| update_at | Long | 参数解释: 更新时间,UTC标准时间毫秒时间戳 取值范围: 不涉及 |
| is_tag | Boolean | 参数解释: 是否是标签 取值范围: |
| 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 | 系统内部错误 |
错误码
请参见错误码。