九游平台/ 代码托管 codearts repo/ api参考/ / / 新建保护tag
更新时间：2024-09-02 gmt 08:00

新建保护tag-九游平台

功能介绍

新建保护tag的规则。

调试

您可以在中调试该接口，支持自动认证鉴权。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

错误码

请参见错误码。

父主题：

相关文档

网站地图