更新时间:2025-08-20 GMT+08:00
分享

获取仓库保护Tag

功能介绍

获取仓库保护Tag

调试

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

URI

GET /v4/repositories/{repository_id}/protected-tag

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

tag_name

String

参数解释:

保护分Tag或通配符列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

Integer

参数解释:

保护Tag ID。

取值范围:

1-2147483647

name

String

参数解释:

分支名称或通配符。

取值范围:

不涉及

actions

Array of RepositoryProtectedActionDto objects

参数解释:

事件列表。

取值范围:

不涉及

表5 RepositoryProtectedActionDto

参数

参数类型

描述

action

String

参数解释:

事件名称。

取值范围:

不涉及。

enable

Boolean

参数解释:

是否启用。

取值范围:

  • true,开启规则限制。

  • false,未开启规则限制。

users

Array of RepositoryUserDto objects

参数解释:

白名单用户列表。

取值范围:

不涉及。

user_teams

Array of UserTeamBasicDto objects

参数解释:

白名单用户组列表。

取值范围:

不涉及。

roles

Array of BasicRoleDto objects

参数解释:

白名单角色列表。

取值范围:

不涉及。

表6 RepositoryUserDto

参数

参数类型

描述

id

Integer

参数解释:

用户id。

取值范围:

1-2147483647

name

String

参数解释:

用户名称。

username

String

参数解释:

用户名。

state

String

参数解释:

用户状态。

取值范围:

不涉及。

avatar_url

String

参数解释:

头像地址。

取值范围:

不涉及。

nick_name

String

参数解释:

用户昵称。

取值范围:

不涉及。

tenant_name

String

参数解释:

所属租户名称。

取值范围:

不涉及。

表7 UserTeamBasicDto

参数

参数类型

描述

id

Integer

参数解释:

用户组ID。

取值范围:

1-2147483647

name

String

参数解释:

用户组名称。

取值范围:

不涉及。

表8 BasicRoleDto

参数

参数类型

描述

id

Integer

参数解释:

角色ID。

取值范围:

1-2147483647

name

String

参数解释:

角色名称。

取值范围:

不涉及。

related_role_id

String

参数解释:

关联角色ID。

取值范围:

不涉及。

chinese_name

String

参数解释:

角色中文名。

取值范围:

不涉及。

请求示例

响应示例

状态码:200

仓库保护Tag

{
  "id" : 124612,
  "name" : "ttt6",
  "actions" : [ {
    "action" : "create",
    "enable" : true,
    "users" : [ {
      "id" : 9124,
      "name" : "user1",
      "username" : "c369c68f1ff84679b5a8ed904d8bff1c",
      "state" : "active",
      "avatar_url" : "",
      "nick_name" : "name",
      "tenant_name" : "t1"
    } ],
    "user_teams" : [ {
      "id" : 251,
      "name" : "team-2"
    } ],
    "roles" : [ {
      "id" : 23836595,
      "name" : "Administrator",
      "related_role_id" : "7a96af96176e4f728f571b8af8551dec",
      "chinese_name" : "项目管理员"
    } ]
  } ]
}

状态码

状态码

描述

200

仓库保护Tag

错误码

请参见错误码

相关文档