获取标签列表
功能介绍
获取标签列表。
URI
GET /v1/{project_id}/system/labels
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Long |
参数解释: 标签列表个数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
labels |
Array of LabelRsp objects |
参数解释: 标签详情列表,包含多个标签信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 标签ID,用于标识唯一标签。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
name |
String |
参数解释: 标签名称,用于标识标签。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
description |
String |
参数解释: 标签描述,用于描述标签的用途或含义。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
creator |
String |
参数解释: 标签创建者,用于标识创建标签的用户。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
create_time |
String |
参数解释: 标签创建时间,用于记录标签的创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
update_time |
String |
参数解释: 标签更新时间,用于记录标签的最后更新时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
level |
Integer |
参数解释: 标签级别,用于前端颜色展示。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
获取系统标签列表。
https://{endpoint}/v1/{project_id}/system/labels
响应示例
状态码:200
OK
{ "count" : 1, "labels" : [ { "id" : "id", "name" : "label1", "description" : "测试标签。", "creator" : "user1", "create_time" : "2021-02-01T14:25:34Z", "update_time" : "2021-02-01T14:25:34Z", "level" : 1 } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。