查询标签
功能介绍
查询标签
调用方法
请参见如何调用API。
URI
GET /v4/projects/{project_id}/tags
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resource_type |
是 |
String |
所属资源类型(TestCase:用例,Task:测试套) |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
success|error; |
|
result |
ResultValueListLabelVo object |
请求返回的数据 |
|
error |
ApiError object |
错误信息 |
|
request_id |
String |
由接口调用方传入,建议使用UUID保证请求的唯一性。 |
|
server_address |
String |
本次请求的受理的服务地址 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 |
|
value |
Array of LabelVo objects |
实际的数据类型:单个对象,集合 或 NULL |
|
reason |
String |
业务失败的提示内容 |
|
page_size |
Integer |
每页展示条数 |
|
page_no |
Integer |
页码 |
|
has_more |
Boolean |
是否有更多 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
uri |
String |
uri主键 |
|
region |
String |
逻辑region |
|
label_name |
String |
标签名称 |
|
service_type |
String |
服务类型 |
|
resource_type |
String |
所属资源类型(TestCase:用例,Task:测试套) |
|
project_uuid |
String |
项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
查询标签
get https://{endpoint}/v4/projects/300c6295a54c4c698608c878f47ddd59/tags?resource_type=TestCase
响应示例
状态码:200
OK
{
"status" : "success",
"result" : {
"value" : [ {
"uri" : "v91j0000vpmr57j9",
"region" : "cn-north-7",
"label_name" : "对对对对对对多",
"resource_type" : "TestCase"
}, {
"uri" : "v91j0vpmr57j939o",
"region" : "cn-north-7",
"label_name" : "咕咕咕咕咕咕过过过过",
"resource_type" : "TestCase"
} ]
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。