更新时间:2024-09-02 GMT+08:00
分享

新建保护tag

功能介绍

新建保护Tag的规则。

调试

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

URI

POST /v2/repositories/{repository_id}/protected-tags

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释

仓库主键ID。

约束限制

必传。

取值范围:

1-2147483647

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

创建保护Tag规则,在产品界面对应“Tag名称”

约束限制

不涉及。

取值范围:

保护Tag规则不能包含空格,且长度为[1-500]个字符。

默认取值:

不涉及。

create_access_level

Integer

参数解释

保护Tag创建权限。

约束限制

不涉及。

取值范围:

  • 0,表示不允许任何人创建符合此规则的Tag。
  • 30,表示开发人员、Committer、项目经理和管理员可创建符合此规则的Tag。
  • 40,项目经理和管理员可修改或删除此符合规则的Tag。

默认取值:

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

参数解释

响应错误。

result

AddProtectTagResponse object

参数解释

响应结果。

status

String

参数解释

响应状态。

取值范围:

  • success,表示“新建保护Tag”成功。
  • fail,表示“新建保护Tag”失败。
表5 Error

参数

参数类型

描述

code

String

参数解释

错误码。

取值范围:

请参见错误码

message

String

参数解释

错误信息。

取值范围:

字符串。

表6 AddProtectTagResponse

参数

参数类型

描述

name

String

参数解释

保护Tag规则,在产品界面对应“Tag名称”

取值范围:

字符串长度范围为[1,500]个字符。

create_access_levels

CreateAccessLevels object

参数解释

保护Tag的权限。

表7 CreateAccessLevels

参数

参数类型

描述

access_level

Integer

参数解释

可创建此Tag规则的权限。

取值范围:

  • 0,不允许任何人创建此规则的Tag。
  • 30,开发人员、Committer、项目经理和管理员创建此规则的Tag。
  • 40,项目经理、管理员可创建此规则的Tag。

access_level_description

String

参数解释

权限描述

取值范围:

  • “Maintainers”, 项目经理、管理员。
  • “Developers + Committer + Maintainers”, 开发人员、Committer、项目经理和管理员。
  • “No one”, 不允许任何人。

请求示例

POST https://{endpoint}/v2/repositories/{repository_id}/protected_tags

{
  "name" : "test",
  "create_access_level" : 40
}

响应示例

状态码: 200

OK

{
  "result" : {
    "name" : "test",
    "create_access_levels" : {
      "access_level" : 40,
      "access_level_description" : "Maintainers"
    }
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档