查询tag列表
功能介绍
查询tag列表。
调用方法
请参见如何调用API。
URI
GET /v1/code/tags
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
scm_type |
是 |
String |
参数解释: 代码源类型。 约束限制: 不涉及。 取值范围: codehub、repo、github。 默认取值: 不涉及。 |
repo_id |
否 |
String |
参数解释: 代码仓ID,使用codehub必填。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
search |
否 |
String |
参数解释: 查询过滤条件。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
page_no |
否 |
Integer |
参数解释: 分页页码,表示从此页开始查询。 约束限制: 正整数。 取值范围: page_no大于等于1。 默认取值: 1 |
page_size |
否 |
Integer |
参数解释: 每页显示的条目数量。 约束限制: 正整数。 取值范围: page_size小于等于100。 默认取值: 10 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取,参考获取IAM用户Token。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
Object |
参数解释: 调用接口成功后返回的数据。 取值范围: 不涉及。 |
status |
String |
参数解释: 返回状态信息。 取值范围: ● success:表示接口调用成功。 ● fail:表示接口调用失败。 |
参数 |
参数类型 |
描述 |
---|---|---|
total |
String |
参数解释: 查询到tag的总数。 取值范围: 不涉及。 |
tag_list |
Array of tag_list objects |
参数解释: tag集合。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v1/code/tags?repo_id=2111668884&search=&scm_type=codehub&page_no=1
响应示例
状态码:200
OK
{ "result" : { "total" : 2, "tag_list" : [ { "name" : 1 } ] }, "status" : "success" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。