# 更新仓库保护Tag - UpdateProtectedTag #### 功能介绍 更新仓库保护Tag #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/doc?api=UpdateProtectedTag&version=v4)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codeartsrepo/codeartsrepo_05_0036.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsrepo:repository:setRepository | Write | - | - | - | - | #### URI PUT /v4/repositories/{repository_id}/protected-tag 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | repository_id | 是 | Integer | **参数解释：** 仓库的ID，通过[查询用户所有仓库](https://support.huaweicloud.com/api-codeartsrepo/ListUserAllRepositories.html)接口查询项目列表获取。 **约束限制：** 不涉及。 **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | tag_name | 是 | String | **参数解释：** 保护分Tag或通配符列表。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | \[数组元素\] | 是 | Array of [RepositoryProtectedTagActionBodyDto] objects | 保护Tag权限列表 | 表5RepositoryProtectedTagActionBodyDto | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enable | 否 | Boolean | **参数解释：** 是否启用。 **约束限制：** 不涉及。 **取值范围：** - true，开启规则限制 - false，关闭规则限制 **默认取值：** 不涉及。 **默认取值：** true | | user_ids | 否 | Array of integers | **参数解释：** 用户ID列表。 **约束限制：** 不涉及。 **取值范围：** Integer **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 | | user_team_ids | 否 | Array of integers | **参数解释：** 成员组ID列表。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 | | related_role_ids | 否 | Array of strings | **参数解释：** 关联角色ID列表。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | action | 否 | String | **参数解释：** 事件名称。 **约束限制：** 不涉及 **取值范围：** - create，创建。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 保护Tag ID。 **取值范围：** 1-2147483647 | | name | String | **参数解释：** 分支名称或通配符。 **取值范围：** 不涉及 | | actions | Array of [RepositoryProtectedActionDto] objects | **参数解释：** 事件列表。 **取值范围：** 不涉及 | 表7RepositoryProtectedActionDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | action | String | **参数解释：** 事件名称。 **取值范围：** 不涉及。 | | enable | Boolean | **参数解释：** 是否启用。 **取值范围：** - true，开启规则限制。 - false，未开启规则限制。 | | users | Array of [RepositoryUserDto] objects | **参数解释：** 白名单用户列表。 **取值范围：** 不涉及。 | | user_teams | Array of [UserTeamBasicDto] objects | **参数解释：** 白名单用户组列表。 **取值范围：** 不涉及。 | | roles | Array of [BasicRoleDto] objects | **参数解释：** 白名单角色列表。 **取值范围：** 不涉及。 | 表8RepositoryUserDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 用户id。 **取值范围：** 1\~2147483647 | | name | String | **参数解释：** 用户名称。 | | username | String | **参数解释：** 用户名。 | | state | String | **参数解释：** 用户状态。 **取值范围：** - active，激活。 - blocked，禁用。 | | avatar_url | String | **参数解释：** 头像地址。 **取值范围：** 不涉及。 | | nick_name | String | **参数解释：** 用户昵称。 **取值范围：** 不涉及。 | | tenant_name | String | **参数解释：** 所属租户名称。 **取值范围：** 不涉及。 | 表9UserTeamBasicDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 用户组ID。 **取值范围：** 1-2147483647 | | name | String | **参数解释：** 用户组名称。 **取值范围：** 不涉及。 | 表10BasicRoleDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 角色ID。 **取值范围：** 1-2147483647 | | name | String | **参数解释：** 角色名称。 **取值范围：** 不涉及。 | | related_role_id | String | **参数解释：** 关联角色ID。 **取值范围：** 不涉及。 | | chinese_name | String | **参数解释：** 角色中文名。 **取值范围：** 不涉及。 | #### 请求示例 更新仓库保护Tag ``` PUT /v4/repositories/123/protected-tag?tag_name=t1 [ { "action" : "create", "enable" : true, "user_ids" : [ 9093 ], "user_team_ids" : [ 247 ], "related_role_ids" : [ "Administrator", "24f72d0b611746c3a43da596ea5065f5" ] } ] ``` #### 响应示例 **状态码：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" : "项目管理员" } ] } ] } ``` #### SDK代码示例 SDK代码示例如下。 #### Java 更新仓库保护Tag ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsrepo.v4.region.CodeArtsRepoRegion; import com.huaweicloud.sdk.codeartsrepo.v4.*; import com.huaweicloud.sdk.codeartsrepo.v4.model.*; import java.util.List; import java.util.ArrayList; public class UpdateProtectedTagSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsRepoClient client = CodeArtsRepoClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsRepoRegion.valueOf("")) .build(); UpdateProtectedTagRequest request = new UpdateProtectedTagRequest(); request.withRepositoryId({repository_id}); List listBodyRelatedRoleIds = new ArrayList<>(); listBodyRelatedRoleIds.add("Administrator"); listBodyRelatedRoleIds.add("24f72d0b611746c3a43da596ea5065f5"); List listBodyUserIds = new ArrayList<>(); listBodyUserIds.add(9093); List listBodyUserTeamIds = new ArrayList<>(); listBodyUserTeamIds.add(247); List listbodyBody = new ArrayList<>(); listbodyBody.add( new RepositoryProtectedTagActionBodyDto() .withUserTeamIds(listBodyUserTeamIds) .withAction(RepositoryProtectedTagActionBodyDto.ActionEnum.fromValue("create")) .withEnable(true) .withUserIds(listBodyUserIds) .withRelatedRoleIds(listBodyRelatedRoleIds) ); request.withBody(listbodyBody); try { UpdateProtectedTagResponse response = client.updateProtectedTag(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` #### Python 更新仓库保护Tag ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsrepo.v4.region.codeartsrepo_region import CodeArtsRepoRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsrepo.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsRepoClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsRepoRegion.value_of("")) \ .build() try: request = UpdateProtectedTagRequest() request.repository_id = {repository_id} listRelatedRoleIdsBody = [ "Administrator", "24f72d0b611746c3a43da596ea5065f5" ] listUserIdsBody = [ 9093 ] listUserTeamIdsBody = [ 247 ] listBodybody = [ RepositoryProtectedTagActionBodyDto( user_team_ids=listUserTeamIdsBody, action="create", enable=True, user_ids=listUserIdsBody, related_role_ids=listRelatedRoleIdsBody ) ] request.body = listBodybody response = client.update_protected_tag(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` #### Go 更新仓库保护Tag ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsrepo "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codeartsrepo.CodeArtsRepoClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartsrepo.NewCodeArtsRepoClient(hcClient) request := &model.UpdateProtectedTagRequest{} request.RepositoryId = int32({repository_id}) var listRelatedRoleIdsBody = []string{ "Administrator", "24f72d0b611746c3a43da596ea5065f5", } var listUserIdsBody = []int32{ int32(9093), } var listUserTeamIdsBody = []int32{ int32(247), } actionBody:= model.GetRepositoryProtectedTagActionBodyDtoActionEnum().CREATE enableBody:= true var listBodybody = []model.RepositoryProtectedTagActionBodyDto{ { UserTeamIds: &listUserTeamIdsBody, Action: &actionBody, Enable: &enableBody, UserIds: &listUserIdsBody, RelatedRoleIds: &listRelatedRoleIdsBody, }, } request.Body = &listBodybody response, err := client.UpdateProtectedTag(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/sdk?api=UpdateProtectedTag&version=v4)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 仓库保护Tag | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codeartsrepo/ErrorCode.html)。