文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Label/ 获取仓库标签列表
更新时间:2025-08-20 GMT+08:00
分享

获取仓库标签列表

功能介绍

获取仓库标签列表

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v4/repositories/{repository_id}/labels

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

仓库的ID,通过查询用户所有仓库接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

偏移量,从0开始。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

参数解释:

返回数量。

取值范围:

1-100

默认取值:

20

search

String

参数解释:

查询关键字,可模糊匹配标签名。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

sort

String

参数解释:

排序。

约束限制:

不涉及。

取值范围:

  • name_asc,按标签名升序。

  • name_desc,按标签名降序。

  • created_asc,按标创建时间升序。

  • created_desc,按标创建时间降序。

  • updated_asc,按标更新时间升序。

  • updated_desc,按标更新时间降序。

默认取值:

name_asc

默认取值:

name_asc

枚举值:

  • name_asc

  • name_desc

  • created_asc

  • created_desc

  • updated_asc

  • updated_desc

include_expired

Boolean

参数解释:

是否包含失效的标签。

约束限制:

不涉及。

取值范围:

  • true,包含。

  • false,不包含。

默认取值:

true

默认取值:

true

view

String

参数解释:

结果集属性,根据给定的参数返回不同的结果。

约束限制:

不涉及。

取值范围:

  • simple,返回简略信息。

  • basic,返回基本信息。

  • detail,返回详细信息。

默认取值:

basic

默认取值:

basic

枚举值:

  • simple

  • basic

  • detail

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of objects

标签列表

请求示例

响应示例

状态码:200

仓库标签列表

[ {
  "id" : 115,
  "name" : "bug",
  "color" : "#6BC950",
  "description" : "",
  "text_color" : "#FFFFFF",
  "expires_at" : "2025-06-10",
  "is_expired" : true,
  "open_merge_requests_count" : 0,
  "priority" : 0,
  "is_repository_label" : true
} ]

状态码

状态码

描述

200

仓库标签列表

错误码

请参见错误码

相关文档