文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ ProtectedTag/ 获取指定项目的保护tag详情
更新时间：2025-09-29 GMT+08:00
查看PDF
分享

获取指定项目的保护tag详情

功能介绍

获取指定项目的保护tag详情

调试

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

URI

GET /v4/projects/{project_id}/protected-tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口查询项目列表获取。

取值范围：

字符串长度32。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ProjectProtectedTagPo objects

保护tag详情列表
表4 ProjectProtectedTagPo

参数

参数类型

描述

id

Integer

参数解释：

保护分支唯一标识。

取值范围：

1-2147483647

source

String

参数解释：

来源。

取值范围：

字符串长度不少于1，不超过1000。

project_id

String

参数解释：

项目id。

取值范围：

字符串长度不少于1，不超过1000。

updated_at

String

参数解释：

更新时间。

取值范围：

字符串长度不少于1，不超过1000。

name

String

参数解释：

保护分支名称

取值范围：

字符串长度不少于1，不超过1000。

actions

Array of ProjectProtectedActionResultDto objects

参数解释：

事件列表。
表5 ProjectProtectedActionResultDto

参数

参数类型

描述

action

String

参数解释：

动作。

取值范围：

字符串长度不少于1，不超过1000。

enable

Boolean

参数解释：

是否开启。

levels

String

参数解释：

权限点。

取值范围：

字符串长度不少于1，不超过1000。

level_names

String

参数解释：

权限名称。

取值范围：

字符串长度不少于1，不超过1000。

users

Array of UserBasicDto objects

参数解释：

成员列表。

user_teams

Array of UserTeamBasicDto objects

参数解释：

成员组列表。

roles

Array of RoleBasicDto objects

参数解释：

角色列表。

addition_switchers

Array of ForceActionEnableDto objects

参数解释：

操作选择列表。
表6 UserBasicDto

参数

参数类型

描述

id

Integer

参数解释：

用户id。

取值范围：

1-2147483647

name

String

参数解释：

用户名称。

username

String

参数解释：

用户名。

state

String

参数解释：

用户状态。

取值范围：

  • active: 可用账户。

  • blocked: 被锁定用户。

  • error: 未查询到该用户。

枚举值：

  • active

  • blocked

  • error

service_license_status

Integer

服务级权限状态 0：停用 1：启用

avatar_url

String

用户头像url

avatar_path

String

用户头像路径

email

String

用户邮箱

name_cn

String

用户中文名称

web_url

String

用户个人首页

nick_name

String

用户昵称

tenant_name

String

租户名称

error_message

String

参数解释：

部分查询接口校验到传参里的用户权限不足或不存在时，返回该用户但该字段不为空用于提示。
表7 UserTeamBasicDto

参数

参数类型

描述

id

Integer

参数解释：

用户组ID。

取值范围：

1-2147483647

name

String

参数解释：

用户组名称。

取值范围：

不涉及。
表8 RoleBasicDto

参数

参数类型

描述

id

Integer

参数解释：

角色唯一标识。

取值范围：

1-2147483647

name

String

参数解释：

角色名称。

取值范围：

字符串长度不少于1，不超过1000。

related_role_id

String

参数解释：

角色id。

取值范围：

字符串长度不少于1，不超过1000。

chinese_name

String

参数解释：

角色中文名称。

取值范围：

字符串长度不少于1，不超过1000。
表9 ForceActionEnableDto

参数

参数类型

描述

name

String

参数解释：

强制操作名称。

取值范围：

字符串长度不少于1，不超过1000。

enable

Boolean

参数解释：

强制操作是否开启。

状态码：401

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：404

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/projects/{project_id}/protected-tags

响应示例

状态码：200

获取指定项目的保护tag详情

[ {
  "id" : 85,
  "source" : null,
  "project_id" : "bf8e0877a109417ba0f184208b44fedc",
  "updated_at" : "2025-09-23",
  "name" : "123",
  "actions" : [ {
    "action" : "create",
    "enable" : false,
    "users" : [ {
      "id" : 1111,
      "name" : "user1",
      "username" : "user1",
      "state" : "active",
      "avatar_url" : null,
      "avatar_path" : null,
      "email" : null,
      "name_cn" : null,
      "web_url" : null,
      "nick_name" : "",
      "tenant_name" : "devcloud_test",
      "error_message" : null
    } ],
    "user_teams" : [ {
      "id" : 1111,
      "name" : "team1"
    } ],
    "roles" : [ {
      "id" : 1111,
      "name" : "Developer",
      "related_role_id" : "dfcd80a52b5e46cab86a8e1fa7ecd25a",
      "chinese_name" : "开发人员"
    } ]
  } ]
}, {
  "id" : 85,
  "source" : null,
  "project_id" : "bf8e0877a109417ba0f184208b44fedc",
  "updated_at" : "2025-09-23",
  "name" : "123",
  "actions" : [ {
    "action" : "create",
    "enable" : false,
    "users" : [ {
      "id" : 1111,
      "name" : "user1",
      "username" : "user1",
      "state" : "active",
      "avatar_url" : null,
      "avatar_path" : null,
      "custom_attributes" : null,
      "email" : null,
      "name_cn" : null,
      "web_url" : null,
      "nick_name" : "",
      "tenant_name" : "devcloud_test",
      "error_message" : null
    } ],
    "user_teams" : [ {
      "id" : 1111,
      "name" : "team1"
    } ],
    "roles" : [ {
      "id" : 1111,
      "name" : "Developer",
      "related_role_id" : "dfcd80a52b5e46cab86a8e1fa7ecd25a",
      "chinese_name" : "开发人员"
    } ]
  } ]
} ]

状态码：401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码：403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "您没有操作权限，请升级权限后重试。"
}

状态码：404

Not Found

{
  "error_code" : "CH.004404",
  "error_msg" : "Project Not Found。Project Not Found"
}

状态码

状态码

描述

200

获取指定项目的保护tag详情

401

Unauthorized

403

Bad Request

404

Not Found

错误码

请参见错误码。

父主题： ProtectedTag

相关文档